### NamingConfigApi: Get Naming Config Examples

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves examples for naming configurations.

```APIDOC
## GET /api/v3/config/naming/examples

### Description
Retrieves examples for naming configurations.

### Method
GET

### Endpoint
/api/v3/config/naming/examples
```

--------------------------------

### Get Naming Configuration Examples

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/NamingConfigApi.md

Retrieves examples of naming configurations.

```APIDOC
## GET /api/v3/config/naming/examples

### Description
Retrieves examples of naming configurations.

### Method
GET

### Endpoint
/api/v3/config/naming/examples

### Parameters
This endpoint does not need any parameters.

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### Response
#### Success Response (200)
OK

#### Response Example
(Response body structure not specified in source)
```

--------------------------------

### Get Naming Configuration Examples

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/NamingConfigApi.md

Retrieves examples of naming configurations with various options.

```APIDOC
## GET /api/v3/namingconfig/examples

### Description
Retrieves examples of naming configurations with various options.

### Method
GET

### Endpoint
/api/v3/namingconfig/examples

### Parameters
#### Query Parameters
- **rename_movies** (bool) - Optional - Description not specified
- **replace_illegal_characters** (bool) - Optional - Description not specified
- **colon_replacement_format** (ColonReplacementFormat) - Optional - Description not specified
- **standard_movie_format** (str) - Optional - Description not specified
- **movie_folder_format** (str) - Optional - Description not specified
- **id** (int) - Optional - Description not specified
- **resource_name** (str) - Optional - Description not specified

### Response
#### Success Response (200)
- **void** - OK (empty response body)

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)
```

--------------------------------

### Get Naming Configuration Examples

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/NamingConfigApi.md

Retrieves examples of naming configurations. Supports API key authentication via 'apikey' or 'X-Api-Key' headers. Optional parameters allow customization of movie renaming, illegal character replacement, and formatting.

```python
import radarr
from radarr.models.colon_replacement_format import ColonReplacementFormat
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.NamingConfigApi(api_client)
    rename_movies = True # bool |  (optional)
    replace_illegal_characters = True # bool |  (optional)
    colon_replacement_format = radarr.ColonReplacementFormat() # ColonReplacementFormat |  (optional)
    standard_movie_format = 'standard_movie_format_example' # str |  (optional)
    movie_folder_format = 'movie_folder_format_example' # str |  (optional)
    id = 56 # int |  (optional)
    resource_name = 'resource_name_example' # str |  (optional)

    try:
        api_instance.get_naming_config_examples(rename_movies=rename_movies, replace_illegal_characters=replace_illegal_characters, colon_replacement_format=colon_replacement_format, standard_movie_format=standard_movie_format, movie_folder_format=movie_folder_format, id=id, resource_name=resource_name)
    except Exception as e:
        print("Exception when calling NamingConfigApi->get_naming_config_examples: %s\n" % e)
```

--------------------------------

### Install radarr-py using Setuptools

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Install the package using Setuptools. This method is useful if you are working with the source code directly or need to install it for all users.

```sh
python setup.py install --user
```

--------------------------------

### Install radarr-py using pip

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Install the package directly from the GitHub repository using pip. This is the recommended method for most users.

```sh
pip install git+https://github.com/devopsarr/radarr-py.git
```

--------------------------------

### Update Host Configuration Example

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/HostConfigApi.md

Demonstrates how to update a host configuration using the radarr client. Includes setup for API key authentication (both 'apikey' and 'X-Api-Key') and error handling. The host is optional and defaults to http://localhost:7878.

```python
import radarr
from radarr.models.host_config_resource import HostConfigResource
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.HostConfigApi(api_client)
    id = 'id_example' # str | 
    host_config_resource = radarr.HostConfigResource() # HostConfigResource |  (optional)

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

```

--------------------------------

### Get All Download Client Configurations

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/DownloadClientConfigApi.md

Retrieves a list of all configured download clients.

```APIDOC
## GET /api/v3/config/downloadclient

### Description
Retrieves a list of all configured download clients.

### Method
GET

### Endpoint
/api/v3/config/downloadclient

### Parameters
This endpoint does not require any parameters.

### Response
#### Success Response (200)
- **list** (array) - A list of download client configurations.

### Response Example
```json
[
  {
    "id": 1,
    "name": "MyClient",
    "implementation": "qBittorrent",
    "host": "localhost",
    "port": 8080,
    "username": "user",
    "password": "pass"
  }
]
```
```

--------------------------------

### Get Metadata by ID

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MetadataApi.md

Retrieves a specific metadata entry using its ID. This example shows the necessary imports and client configuration for authentication.

```python
import radarr
from radarr.models.metadata_resource import MetadataResource
from radarr.rest import ApiException
from pprint import pprint
import os

configuration = radarr.Configuration(
    host = "http://localhost:7878"
)

configuration.api_key['apikey'] = os.environ["API_KEY"]
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

```

--------------------------------

### Update Import Exclusion

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ImportExclusionsApi.md

Updates an existing import exclusion. This example shows the basic setup for the API client, including authentication configuration.

```python
import radarr
from radarr.models.import_exclusions_resource import ImportExclusionsResource
from radarr.rest import ApiException
from pprint import pprint
import os

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

# 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'


```

--------------------------------

### Instantiate DownloadClientConfigResource

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/DownloadClientConfigResource.md

Demonstrates how to create an instance of DownloadClientConfigResource from a JSON string or a dictionary. It also shows how to convert the object back to a dictionary or JSON string.

```python
from radarr.models.download_client_config_resource import DownloadClientConfigResource

# TODO update the JSON string below
json = "{}"
# create an instance of DownloadClientConfigResource from a JSON string
download_client_config_resource_instance = DownloadClientConfigResource.from_json(json)
# print the JSON string representation of the object
print(DownloadClientConfigResource.to_json())

# convert the object into a dict
download_client_config_resource_dict = download_client_config_resource_instance.to_dict()
# create an instance of DownloadClientConfigResource from a dict
download_client_config_resource_from_dict = DownloadClientConfigResource.from_dict(download_client_config_resource_dict)
```

--------------------------------

### List Metadata Schema using Radarr API

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MetadataApi.md

Fetches the schema for metadata resources. This example shows the setup for API key authentication, similar to other API calls.

```python
import radarr
from radarr.models.metadata_resource import MetadataResource
from radarr.rest import ApiException
from pprint import pprint
import os

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

# 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'


```

--------------------------------

### List Commands using radarr-py

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/CommandApi.md

Shows how to fetch a list of all commands using the radarr-py library. This example requires API key authentication to be set up.

```python
import radarr
from radarr.models.command_resource import CommandResource
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.CommandApi(api_client)

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

--------------------------------

### Instantiate and Use Version Model

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/Version.md

Demonstrates how to create a Version model instance from a JSON string, convert it to a dictionary, and create a new instance from a dictionary. Requires the Version model to be imported.

```python
from radarr.models.version import Version

# TODO update the JSON string below
json = "{}"
# create an instance of Version from a JSON string
version_instance = Version.from_json(json)
# print the JSON string representation of the object
print Version.to_json()

# convert the object into a dict
version_dict = version_instance.to_dict()
# create an instance of Version from a dict
version_form_dict = version.from_dict(version_dict)
```

--------------------------------

### Reorder Delay Profiles

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/DelayProfileApi.md

Reorders delay profiles. This example shows the initial setup for API key authentication and client instantiation, but the actual reordering call is not fully shown.

```python
import radarr
from radarr.models.delay_profile_resource import DelayProfileResource
from radarr.rest import ApiException
from pprint import pprint
import os

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

# 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'


```

--------------------------------

### MediaInfoResource Instantiation and Conversion

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MediaInfoResource.md

Demonstrates how to create a MediaInfoResource instance from a JSON string and convert it to a dictionary. Also shows how to convert an instance back from a dictionary.

```python
from radarr.models.media_info_resource import MediaInfoResource

# TODO update the JSON string below
json = "{}"
# create an instance of MediaInfoResource from a JSON string
media_info_resource_instance = MediaInfoResource.from_json(json)
# print the JSON string representation of the object
print(MediaInfoResource.to_json())

# convert the object into a dict
media_info_resource_dict = media_info_resource_instance.to_dict()
# create an instance of MediaInfoResource from a dict
media_info_resource_from_dict = MediaInfoResource.from_dict(media_info_resource_dict)
```

--------------------------------

### Get Localization Language Resources using radarr-py

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/LocalizationApi.md

This snippet shows how to fetch specific localization language resources. It includes API key authentication setup and error handling, similar to the general localization retrieval.

```python
import radarr
from radarr.models.localization_language_resource import LocalizationLanguageResource
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.LocalizationApi(api_client)

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

--------------------------------

### List All Import Exclusions

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ImportExclusionsApi.md

Fetches a list of all configured import exclusions. This example demonstrates setting up the API client with API key authentication for both 'apikey' and 'X-Api-Key' methods.

```python
import radarr
from radarr.models.import_exclusions_resource import ImportExclusionsResource
from radarr.rest import ApiException
from pprint import pprint
import os

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.ImportExclusionsApi(api_client)

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

--------------------------------

### Delete Command using Radarr API

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/CommandApi.md

This example shows how to delete a command by its ID using the Radarr API. It includes the necessary setup for the API client and authentication. The command ID is passed as an integer parameter.

```python
import radarr
from radarr.rest import ApiException
from pprint import pprint

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

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

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

--------------------------------

### Instantiate MediaCover from JSON and Dictionary

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MediaCover.md

Demonstrates creating a MediaCover object from a JSON string or a Python dictionary. Also shows how to convert the object back to a dictionary or JSON string.

```python
from radarr.models.media_cover import MediaCover

# TODO update the JSON string below
json = "{}"
# create an instance of MediaCover from a JSON string
media_cover_instance = MediaCover.from_json(json)
# print the JSON string representation of the object
print(MediaCover.to_json())

# convert the object into a dict
media_cover_dict = media_cover_instance.to_dict()
# create an instance of MediaCover from a dict
media_cover_from_dict = MediaCover.from_dict(media_cover_dict)
```

--------------------------------

### Instantiate BackupResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/BackupResource.md

Demonstrates creating a BackupResource instance from a JSON string or a dictionary, and converting it back to JSON or a dictionary. Ensure the JSON string is valid.

```python
from radarr.models.backup_resource import BackupResource

# TODO update the JSON string below
json = "{}"
# create an instance of BackupResource from a JSON string
backup_resource_instance = BackupResource.from_json(json)
# print the JSON string representation of the object
print(BackupResource.to_json())

# convert the object into a dict
backup_resource_dict = backup_resource_instance.to_dict()
# create an instance of BackupResource from a dict
backup_resource_from_dict = BackupResource.from_dict(backup_resource_dict)
```

--------------------------------

### Configure API Key and Call put_movie_file_editor

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MovieFileApi.md

Demonstrates how to configure API key authorization and then call the put_movie_file_editor method. Ensure your API key is set in the environment variable API_KEY.

```python
import radarr
import os

# Configure API key authorization: X-Api-Key
configuration = radarr.Configuration(
    host = "http://localhost:7878"
)
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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.MovieFileApi(api_client)
    movie_file_list_resource = radarr.MovieFileListResource() # MovieFileListResource |  (optional)

    try:
        api_instance.put_movie_file_editor(movie_file_list_resource=movie_file_list_resource)
    except Exception as e:
        print("Exception when calling MovieFileApi->put_movie_file_editor: %s\n" % e)
```

--------------------------------

### GET /ping

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/PingApi.md

Checks the service status by sending a GET request to the /ping endpoint. It returns a PingResource object upon successful execution.

```APIDOC
## GET /ping

### Description
Checks the service status by sending a GET request to the /ping endpoint. It returns a PingResource object upon successful execution.

### Method
GET

### Endpoint
/ping

### Parameters
This endpoint does not need any parameters.

### Return type
[PingResource](PingResource.md)

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json

### Response
#### Success Response (2XX)
OK

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### MediaManagementConfigResource Usage

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MediaManagementConfigResource.md

Demonstrates how to create an instance of MediaManagementConfigResource from a JSON string, convert it to a dictionary, and create a new instance from a dictionary. Ensure the JSON string is valid.

```python
from radarr.models.media_management_config_resource import MediaManagementConfigResource

# TODO update the JSON string below
json = "{}"
# create an instance of MediaManagementConfigResource from a JSON string
media_management_config_resource_instance = MediaManagementConfigResource.from_json(json)
# print the JSON string representation of the object
print(MediaManagementConfigResource.to_json())

# convert the object into a dict
media_management_config_resource_dict = media_management_config_resource_instance.to_dict()
# create an instance of MediaManagementConfigResource from a dict
media_management_config_resource_from_dict = MediaManagementConfigResource.from_dict(media_management_config_resource_dict)
```

--------------------------------

### Create Download Client Action by Name

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/DownloadClientApi.md

Use this method to create a download client by specifying its name. The `download_client_resource` parameter is optional.

```python
import radarr
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.DownloadClientApi(api_client)
    name = 'name_example' # str | 
    download_client_resource = radarr.DownloadClientResource() # DownloadClientResource |  (optional)

    try:
        api_instance.create_download_client_action_by_name(name, download_client_resource=download_client_resource)
    except Exception as e:
        print("Exception when calling DownloadClientApi->create_download_client_action_by_name: %s\n" % e)
```

--------------------------------

### Get Ping Status with API Key Authentication

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/PingApi.md

Use this snippet to get the ping status of the Radarr instance using API key authentication. Ensure your API key is set in the environment variable 'API_KEY'.

```python
import radarr
from radarr.models.ping_resource import PingResource
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.PingApi(api_client)

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

--------------------------------

### BlocklistApi - Get Blocklist

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves the blocklist.

```APIDOC
## GET /api/v3/blocklist

### Description
Retrieves the blocklist.

### Method
GET

### Endpoint
/api/v3/blocklist
```

--------------------------------

### Instantiate QualityProfileQualityItemResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/QualityProfileQualityItemResource.md

Demonstrates creating a QualityProfileQualityItemResource instance from a JSON string or a dictionary. Also shows how to convert the instance back to a dictionary or JSON string.

```python
from radarr.models.quality_profile_quality_item_resource import QualityProfileQualityItemResource

# TODO update the JSON string below
json = "{}"
# create an instance of QualityProfileQualityItemResource from a JSON string
quality_profile_quality_item_resource_instance = QualityProfileQualityItemResource.from_json(json)
# print the JSON string representation of the object
print(QualityProfileQualityItemResource.to_json())

# convert the object into a dict
quality_profile_quality_item_resource_dict = quality_profile_quality_item_resource_instance.to_dict()
# create an instance of QualityProfileQualityItemResource from a dict
quality_profile_quality_item_resource_from_dict = QualityProfileQualityItemResource.from_dict(quality_profile_quality_item_resource_dict)
```

--------------------------------

### Get Blocklist

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/BlocklistApi.md

Retrieves the entire blocklist.

```APIDOC
## GET /api/v3/blocklist

### Description
Retrieves the entire blocklist.

### Method
GET

### Endpoint
/api/v3/blocklist

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details
| Status code | Description |
|-------------|-------------|
| **200** | OK |
```

--------------------------------

### Instantiate AlternativeTitleResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/AlternativeTitleResource.md

Demonstrates creating an AlternativeTitleResource instance from a JSON string and a dictionary. Also shows how to convert the object back to a dictionary and its JSON string representation.

```python
from radarr.models.alternative_title_resource import AlternativeTitleResource

# TODO update the JSON string below
json = "{}"
# create an instance of AlternativeTitleResource from a JSON string
alternative_title_resource_instance = AlternativeTitleResource.from_json(json)
# print the JSON string representation of the object
print(AlternativeTitleResource.to_json())

# convert the object into a dict
alternative_title_resource_dict = alternative_title_resource_instance.to_dict()
# create an instance of AlternativeTitleResource from a dict
alternative_title_resource_from_dict = AlternativeTitleResource.from_dict(alternative_title_resource_dict)
```

--------------------------------

### CreditApi - Get Credits

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves credit information.

```APIDOC
## GET /api/v3/credit

### Description
Retrieves credit information.

### Method
GET

### Endpoint
/api/v3/credit
```

--------------------------------

### PingApi: Get Ping

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Checks if the Radarr service is running.

```APIDOC
## GET /ping

### Description
Pings the Radarr service to check if it is running.

### Method
GET

### Endpoint
/ping
```

--------------------------------

### Instantiate ApiInfoResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ApiInfoResource.md

Demonstrates creating an ApiInfoResource instance from a JSON string or a dictionary. Also shows how to convert the object back to JSON or a dictionary.

```python
from radarr.models.api_info_resource import ApiInfoResource

# TODO update the JSON string below
json = "{}"
# create an instance of ApiInfoResource from a JSON string
api_info_resource_instance = ApiInfoResource.from_json(json)
# print the JSON string representation of the object
print(ApiInfoResource.to_json())

# convert the object into a dict
api_info_resource_dict = api_info_resource_instance.to_dict()
# create an instance of ApiInfoResource from a dict
api_info_resource_from_dict = ApiInfoResource.from_dict(api_info_resource_dict)
```

--------------------------------

### SelectOption Model Usage

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/SelectOption.md

Demonstrates how to create a SelectOption instance from a JSON string, convert it to a dictionary, and create an instance from a dictionary. Ensure the JSON string is valid.

```python
from radarr.models.select_option import SelectOption

# TODO update the JSON string below
json = "{}"
# create an instance of SelectOption from a JSON string
select_option_instance = SelectOption.from_json(json)
# print the JSON string representation of the object
print(SelectOption.to_json())

# convert the object into a dict
select_option_dict = select_option_instance.to_dict()
# create an instance of SelectOption from a dict
select_option_from_dict = SelectOption.from_dict(select_option_dict)
```

--------------------------------

### HistoryApi: Get History

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves the history of Radarr activities.

```APIDOC
## GET /api/v3/history

### Description
Retrieves the history of Radarr activities.

### Method
GET

### Endpoint
/api/v3/history
```

--------------------------------

### Instantiate QualityDefinitionResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/QualityDefinitionResource.md

Demonstrates creating a QualityDefinitionResource object from a JSON string and a dictionary. Also shows converting the object back to JSON and a dictionary.

```python
from radarr.models.quality_definition_resource import QualityDefinitionResource

# TODO update the JSON string below
json = "{}"
# create an instance of QualityDefinitionResource from a JSON string
quality_definition_resource_instance = QualityDefinitionResource.from_json(json)
# print the JSON string representation of the object
print(QualityDefinitionResource.to_json())

# convert the object into a dict
quality_definition_resource_dict = quality_definition_resource_instance.to_dict()
# create an instance of QualityDefinitionResource from a dict
quality_definition_resource_from_dict = QualityDefinitionResource.from_dict(quality_definition_resource_dict)
```

--------------------------------

### AuthenticationApi - Get Logout

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Logs out the current user session.

```APIDOC
## GET /logout

### Description
Logs out the current user session.

### Method
GET

### Endpoint
/logout
```

--------------------------------

### Create Root Folder using Radarr API

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/RootFolderApi.md

Demonstrates how to create a new root folder using the Radarr API. Requires API key authentication. Ensure the RootFolderResource model is correctly populated.

```python
import radarr
from radarr.models.root_folder_resource import RootFolderResource
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.RootFolderApi(api_client)
    root_folder_resource = radarr.RootFolderResource() # RootFolderResource |  (optional)

    try:
        api_response = api_instance.create_root_folder(root_folder_resource=root_folder_resource)
        print("The response of RootFolderApi->create_root_folder:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RootFolderApi->create_root_folder: %s\n" % e)
```

--------------------------------

### Get Restriction By ID

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/RestrictionApi.md

Retrieves a specific restriction by its ID.

```APIDOC
## GET /api/v3/restriction/{id}

### Description
Retrieves a specific restriction by its ID.

### Method
GET

### Endpoint
/api/v3/restriction/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the restriction to retrieve.

### Response
#### Success Response (200)
- **RestrictionResource** (RestrictionResource) - The requested restriction resource.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### NamingConfigApi: Get Naming Config

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves the global naming configuration.

```APIDOC
## GET /api/v3/config/naming

### Description
Retrieves the global naming configuration.

### Method
GET

### Endpoint
/api/v3/config/naming
```

--------------------------------

### CreditApi - Get Credit by ID

Source: https://github.com/devopsarr/radarr-py/blob/main/README.md

Retrieves credit information by ID.

```APIDOC
## GET /api/v3/credit/{id}

### Description
Retrieves credit information by ID.

### Method
GET

### Endpoint
/api/v3/credit/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the credit to retrieve.
```

--------------------------------

### Instantiate MovieFileResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/MovieFileResource.md

Demonstrates how to create a MovieFileResource instance from a JSON string or a Python dictionary. Also shows how to convert the object back to a dictionary or JSON string.

```python
from radarr.models.movie_file_resource import MovieFileResource

# TODO update the JSON string below
json = "{}"
# create an instance of MovieFileResource from a JSON string
movie_file_resource_instance = MovieFileResource.from_json(json)
# print the JSON string representation of the object
print(MovieFileResource.to_json())

# convert the object into a dict
movie_file_resource_dict = movie_file_resource_instance.to_dict()
# create an instance of MovieFileResource from a dict
movie_file_resource_from_dict = MovieFileResource.from_dict(movie_file_resource_dict)
```

--------------------------------

### SystemResource Model Usage

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/SystemResource.md

Demonstrates how to create and manipulate SystemResource objects. Use from_json to parse JSON data into an instance, and to_json to serialize an instance back to JSON. to_dict converts the object to a dictionary, and from_dict creates an object from a dictionary.

```python
from radarr.models.system_resource import SystemResource

# TODO update the JSON string below
json = "{}"
# create an instance of SystemResource from a JSON string
system_resource_instance = SystemResource.from_json(json)
# print the JSON string representation of the object
print(SystemResource.to_json())

# convert the object into a dict
system_resource_dict = system_resource_instance.to_dict()
# create an instance of SystemResource from a dict
system_resource_from_dict = SystemResource.from_dict(system_resource_dict)
```

--------------------------------

### Get Quality Definition Limits

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/QualityDefinitionApi.md

Retrieves the limits for quality definitions.

```APIDOC
## GET /api/v3/qualitydefinition/limits

### Description
Retrieves the limits for quality definitions.

### Method
GET

### Endpoint
/api/v3/qualitydefinition/limits

### Authorization
- apikey
- X-Api-Key

### Response
#### Success Response (200)
- **QualityDefinitionLimitsResource** - The quality definition limits.

### Request Example
```python
import radarr
from radarr.models.quality_definition_limits_resource import QualityDefinitionLimitsResource
from radarr.rest import ApiException
from pprint import pprint

configuration = radarr.Configuration(
    host = "http://localhost:7878"
)
configuration.api_key['apikey'] = os.environ["API_KEY"]
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

with radarr.ApiClient(configuration) as api_client:
    api_instance = radarr.QualityDefinitionApi(api_client)
    try:
        api_response = api_instance.get_quality_definition_limits()
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QualityDefinitionApi->get_quality_definition_limits: %s\n" % e)
```
```

--------------------------------

### Get Naming Configuration

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/NamingConfigApi.md

Retrieves the current naming configuration settings.

```APIDOC
## GET /api/v3/config/naming

### Description
Retrieves the current naming configuration settings.

### Method
GET

### Endpoint
/api/v3/config/naming

### Parameters
This endpoint does not need any parameters.

### Return type
[NamingConfigResource](NamingConfigResource.md)

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### Request Example
```python
import radarr
from radarr.models.naming_config_resource import NamingConfigResource
from radarr.rest import ApiException
from pprint import pprint

configuration = radarr.Configuration(
    host = "http://localhost:7878"
)

configuration.api_key['apikey'] = os.environ["API_KEY"]
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

with radarr.ApiClient(configuration) as api_client:
    api_instance = radarr.NamingConfigApi(api_client)
    try:
        api_response = api_instance.get_naming_config()
        print("The response of NamingConfigApi->get_naming_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NamingConfigApi->get_naming_config: %s\n" % e)
```

### Response
#### Success Response (200)
OK

#### Response Example
(Response body structure depends on NamingConfigResource model)
```

--------------------------------

### HostConfigResource Model Usage

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/HostConfigResource.md

Demonstrates how to create an instance of HostConfigResource from a JSON string, convert it to a dictionary, and create it from a dictionary. Ensure the JSON string is valid and properly formatted.

```python
from radarr.models.host_config_resource import HostConfigResource

# TODO update the JSON string below
json = "{}"
# create an instance of HostConfigResource from a JSON string
host_config_resource_instance = HostConfigResource.from_json(json)
# print the JSON string representation of the object
print(HostConfigResource.to_json())

# convert the object into a dict
host_config_resource_dict = host_config_resource_instance.to_dict()
# create an instance of HostConfigResource from a dict
host_config_resource_from_dict = HostConfigResource.from_dict(host_config_resource_dict)
```

--------------------------------

### Get Import Lists

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ImportListApi.md

Retrieves a list of all configured import lists.

```APIDOC
## GET /api/v3/importlist

### Description
Retrieves a list of all configured import lists.

### Method
GET

### Endpoint
/api/v3/importlist

### Response
#### Success Response (200)
- **list** (array[ImportListResource]) - An array of ImportListResource objects, each representing an import list.

#### Response Example
```json
{
  "list": [
    {
      "name": "My Movie List",
      "listType": "movie",
      "searchMechanism": " செய்யுங்கள்",
      "enableDiscover": true,
      "tags": [1],
      "tmdbId": [603],
      "imdbId": ["tt0111161"]
    },
    {
      "name": "My Series List",
      "listType": "series",
      "searchMechanism": " செய்யுங்கள்",
      "enableDiscover": false,
      "tags": [2],
      "tvdbId": [12345],
      "imdbId": ["tt0068646"]
    }
  ]
}
```

### 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 |  -  |
```

--------------------------------

### Instantiate ReleaseProfileResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ReleaseProfileResource.md

Demonstrates creating a ReleaseProfileResource instance from a JSON string or a dictionary. Also shows how to convert the object back to JSON or a dictionary.

```python
from radarr.models.release_profile_resource import ReleaseProfileResource

# TODO update the JSON string below
json = "{}"
# create an instance of ReleaseProfileResource from a JSON string
release_profile_resource_instance = ReleaseProfileResource.from_json(json)
# print the JSON string representation of the object
print(ReleaseProfileResource.to_json())

# convert the object into a dict
release_profile_resource_dict = release_profile_resource_instance.to_dict()
# create an instance of ReleaseProfileResource from a dict
release_profile_resource_from_dict = ReleaseProfileResource.from_dict(release_profile_resource_dict)
```

--------------------------------

### Instantiate ReleaseResource from JSON and Dict

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ReleaseResource.md

Demonstrates how to create a ReleaseResource object from a JSON string or a Python dictionary, and how to convert it back to JSON or a dictionary. Ensure the JSON string is valid.

```python
from radarr.models.release_resource import ReleaseResource

# TODO update the JSON string below
json = "{}"
# create an instance of ReleaseResource from a JSON string
release_resource_instance = ReleaseResource.from_json(json)
# print the JSON string representation of the object
print(ReleaseResource.to_json())

# convert the object into a dict
release_resource_dict = release_resource_instance.to_dict()
# create an instance of ReleaseResource from a dict
release_resource_from_dict = ReleaseResource.from_dict(release_resource_dict)
```

--------------------------------

### Get Exclusions By ID

Source: https://github.com/devopsarr/radarr-py/blob/main/docs/ImportExclusionsApi.md

Retrieves a specific import exclusion by its ID.

```APIDOC
## GET /api/v3/import/exclusions/{id}

### Description
Retrieves a specific import exclusion by its ID.

### Method
GET

### Endpoint
/api/v3/import/exclusions/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The ID of the import exclusion to retrieve.

### Response
#### Success Response (200)
- **ImportExclusionsResource** - Details of the requested import exclusion.

### Authorization
[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
```