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

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/NamingConfigApi.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

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

### Request Example
```python
import whisparr
from pprint import pprint

configuration = whisparr.Configuration(
    host = "http://localhost:7878"
)
configuration.api_key['apikey'] = 'YOUR_API_KEY'

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

### Response
#### Success Response (200)
- **NamingConfigResource** (NamingConfigResource) - Examples of naming configurations.

#### Response Example
```json
{
  "example": "NamingConfigResource object with examples"
}
```

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

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

### GET /api/v1/naming.config.examples

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

Retrieves examples for naming configurations. This endpoint allows you to get sample configurations for various naming settings, which can be useful for understanding the available options and their effects.

```APIDOC
## GET /api/v1/naming.config.examples

### Description
Retrieves examples for naming configurations.

### Method
GET

### Endpoint
/api/v1/naming.config.examples

### Parameters
#### Query Parameters
- **rename_movies** (bool) - Optional - 
- **replace_illegal_characters** (bool) - Optional - 
- **colon_replacement_format** (ColonReplacementFormat) - Optional - 
- **standard_movie_format** (str) - Optional - 
- **movie_folder_format** (str) - Optional - 
- **include_quality** (bool) - Optional - 
- **replace_spaces** (bool) - Optional - 
- **separator** (str) - Optional - 
- **number_style** (str) - Optional - 
- **id** (int) - Optional - 
- **resource_name** (str) - Optional - 

### Request Example
```json
{
  "rename_movies": true,
  "replace_illegal_characters": true,
  "colon_replacement_format": {
    "colon_replacement_format": "example"
  },
  "standard_movie_format": "standard_movie_format_example",
  "movie_folder_format": "movie_folder_format_example",
  "include_quality": true,
  "replace_spaces": true,
  "separator": "separator_example",
  "number_style": "number_style_example",
  "id": 56,
  "resource_name": "resource_name_example"
}
```

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

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

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
```

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

### Get Naming Configuration Examples with API Key Auth

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

Demonstrates how to authenticate with the Whisparr API using an API key and retrieve naming configuration examples. Ensure your API key is set in the environment variable 'API_KEY'.

```python
import whisparr
from whisparr.models.colon_replacement_format import ColonReplacementFormat
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.NamingConfigApi(api_client)
    rename_movies = True # bool |  (optional)
    replace_illegal_characters = True # bool |  (optional)
    colon_replacement_format = whisparr.ColonReplacementFormat() # ColonReplacementFormat |  (optional)
    standard_movie_format = 'standard_movie_format_example' # str |  (optional)
    movie_folder_format = 'movie_folder_format_example' # str |  (optional)
    include_quality = True # bool |  (optional)
    replace_spaces = True # bool |  (optional)
    separator = 'separator_example' # str |  (optional)
    number_style = 'number_style_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, include_quality=include_quality, replace_spaces=replace_spaces, separator=separator, number_style=number_style, id=id, resource_name=resource_name)
    except Exception as e:
        print("Exception when calling NamingConfigApi->get_naming_config_examples: %s\n" % e)

```

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

### Authenticate with API Key and Get System Status

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/SystemApi.md

This example shows how to configure API key authentication for both 'apikey' and 'X-Api-Key' and then retrieve the system status. Ensure the 'API_KEY' environment variable is set.

```python
import whisparr
from whisparr.models.system_resource import SystemResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.SystemApi(api_client)

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

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

### Test All Metadata with Whisparr API

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

Demonstrates how to call the testall_metadata function. This example includes API key authentication setup.

```python
import whisparr
from whisparr.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 = whisparr.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'

```

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

### Python Example for Parse API get_parse

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ParseApi.md

Demonstrates how to use the `get_parse` method from the Parse API. Includes setup for API key authentication and error handling. Ensure your API key is set as an environment variable `API_KEY`.

```python
import whisparr
from whisparr.models.parse_resource import ParseResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.ParseApi(api_client)
    title = 'title_example' # str |  (optional)

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

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

### Get API Information using ApiInfoApi

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ApiInfoApi.md

Example of how to call the get_api method to fetch API information. It demonstrates setting up the API client, configuring authentication (API Key), and handling the response or exceptions. Ensure your API key is set in the environment variable API_KEY.

```python
import whisparr
from whisparr.models.api_info_resource import ApiInfoResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.ApiInfoApi(api_client)

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

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

### GET /command

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

Lists all available commands.

```APIDOC
## GET /command

### Description
Lists all available commands.

### Method
GET

### Endpoint
/command

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

### Request Example
```python
# No request body for this endpoint
```

### Response
#### Success Response (200)
- **List[CommandResource]** - A list of command resources.

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

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

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

### AlternativeTitleApi - Get Alternative Title by ID

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

Retrieves an alternative title by its unique identifier. This is a basic example demonstrating how to instantiate the client, configure authentication, and make a GET request to the API.

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

### Description
Retrieves an alternative title by its unique identifier.

### Method
GET

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

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

### Request Example
```python
import whisparr
from whisparr.rest import ApiException
from pprint import pprint

configuration = whisparr.Configuration(
    host = "http://localhost:7878"
)
configuration.api_key['apikey'] = os.environ["API_KEY"]

with whisparr.ApiClient(configuration) as api_client:
    api_instance = whisparr.AlternativeTitleApi(api_client)
    id = 56 

    try:
        api_response = api_instance.get_alttitle_by_id(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlternativeTitleApi->get_alttitle_by_id: %s\n" % e)
```

### Response
#### Success Response (200)
- **field1** (type) - Description of the field returned in the response.
```

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

### List Release Profiles

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ReleaseProfileApi.md

Fetches a list of all available release profiles. This example demonstrates setting up API key authentication and initializing the API client within a context manager.

```python
import whisparr
from whisparr.models.release_profile_resource import ReleaseProfileResource
from whisparr.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 = whisparr.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'


```

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

### Get Ping Status using whisparr-py

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

This example demonstrates how to use the PingApi to get the server's ping status. It shows how to configure the API client with authentication (API Key) and make the GET /ping request. Ensure you have the 'API_KEY' environment variable set for authentication.

```python
import whisparr
from whisparr.models.ping_resource import PingResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.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)
```

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

### Create Download Client

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

Instantiate the DownloadClientApi and create a new download client. This example uses API key authentication.

```python
import whisparr
from whisparr.rest import ApiException

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

with whisparr.ApiClient(configuration) as api_client:
    api_instance = whisparr.DownloadClientApi(api_client)
    name = 'name_example'
    download_client_resource = whisparr.DownloadClientResource()

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

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

### List Custom Filters with Whisparr API

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/CustomFilterApi.md

Provides an example of how to list all custom filters using the CustomFilterApi. This snippet includes authentication setup.

```python
import whisparr
from whisparr.models.custom_filter_resource import CustomFilterResource
from whisparr.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 = whisparr.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 All Import Exclusions

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

Fetches a list of all import exclusions. This example demonstrates setting up the API client with host configuration and API key authentication for both 'apikey' and 'X-Api-Key' methods. It also includes error handling for the API call.

```python
import whisparr
from whisparr.models.import_exclusions_resource import ImportExclusionsResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.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)
```

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

### Instantiate and Use UiConfigResource

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/UiConfigResource.md

Demonstrates creating a UiConfigResource instance from a JSON string, converting it to a dictionary, and creating it from a dictionary. Ensure the JSON string is valid before parsing.

```python
from whisparr.models.ui_config_resource import UiConfigResource

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

# convert the object into a dict
ui_config_resource_dict = ui_config_resource_instance.to_dict()
# create an instance of UiConfigResource from a dict
ui_config_resource_from_dict = UiConfigResource.from_dict(ui_config_resource_dict)
```

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

### Test Metadata with Whisparr API

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

Shows how to test metadata using the MetadataApi. This example includes API key authentication setup and requires a MetadataResource object.

```python
import whisparr
from whisparr.models.metadata_resource import MetadataResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.MetadataApi(api_client)
    metadata_resource = whisparr.MetadataResource() # MetadataResource |  (optional)

    try:
        api_instance.test_metadata(metadata_resource=metadata_resource)
    except Exception as e:
        print("Exception when calling MetadataApi->test_metadata: %s\n" % e)
```

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

### List Import List Exclusions

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ImportListExclusionApi.md

Retrieves a list of all import list exclusions. This example demonstrates the setup for API key authentication and making the API call.

```python
from __future__ import print_function
import time
import os
import whisparr
from whisparr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:6969
# See configuration.py for a list of all supported configuration parameters.
configuration = whisparr.Configuration(
    host = "http://localhost:6969"
)

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

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

### Create and Convert MonitoringOptions

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/MonitoringOptions.md

Demonstrates creating a MonitoringOptions instance from a JSON string and converting it to a dictionary. Also shows converting a dictionary back to a MonitoringOptions instance. Requires the MonitoringOptions model.

```python
from 
whisparr.models.monitoring_options import MonitoringOptions

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

# convert the object into a dict
monitoring_options_dict = monitoring_options_instance.to_dict()
# create an instance of MonitoringOptions from a dict
monitoring_options_form_dict = monitoring_options.from_dict(monitoring_options_dict)
```

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

### Get Custom Filter by ID with Whisparr API

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/CustomFilterApi.md

Shows how to retrieve a specific custom filter by its ID using the CustomFilterApi. This example includes setting up API key authentication.

```python
import whisparr
from whisparr.models.custom_filter_resource import CustomFilterResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.CustomFilterApi(api_client)
    id = 56 # int | 

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

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

### List Import Lists

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

Fetches a list of all import lists. This example sets up the client configuration and authentication.

```python
import whisparr
from whisparr.models.import_list_resource import ImportListResource
from whisparr.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.

```

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

### Configure Whisparr Client with API Key Authentication

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

Initializes the Whisparr configuration, setting the host and API key for authentication. This example shows how to set up both 'apikey' and 'X-Api-Key' schemes.

```python
import whisparr
from whisparr.models.import_list_resource import ImportListResource
from whisparr.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 = whisparr.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'
```

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

### Get Auto Tagging Entry by ID

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/AutoTaggingApi.md

Retrieves a specific auto-tagging entry using its ID. This example demonstrates API key authentication and handling potential API exceptions.

```python
import whisparr
from whisparr.models.auto_tagging_resource import AutoTaggingResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.AutoTaggingApi(api_client)
    id = 56 # int | 

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

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

### Create and Use ReleaseResource Instance

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

Demonstrates how to create a ReleaseResource instance 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 whisparr.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 Release Profile by ID

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ReleaseProfileApi.md

Retrieves a specific release profile by its ID. This example shows how to configure the API client with API key authentication and handle the response or potential exceptions.

```python
import whisparr
from whisparr.models.release_profile_resource import ReleaseProfileResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.ReleaseProfileApi(api_client)
    id = 56 # int | 

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

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

### SystemResource Model Usage

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

Demonstrates how to create a SystemResource instance from a JSON string and convert it to a dictionary. Also shows how to convert an instance back from a dictionary. Ensure the JSON string is valid.

```python
from whisparr.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)
```

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

### Update Episode Files via Editor (API Key Auth)

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/EpisodeFileApi.md

This example shows how to update episode files using the editor functionality. It requires API key authentication and client setup.

```python
from __future__ import print_function
import time
import os
import whisparr
from whisparr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:6969
# See configuration.py for a list of all supported configuration parameters.
configuration = whisparr.Configuration(
    host = "http://localhost:6969"
)

# 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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.EpisodeFileApi(api_client)
    episode_file_list_resource = whisparr.EpisodeFileListResource() # EpisodeFileListResource |  (optional)

    try:
        api_instance.put_episode_file_editor(episode_file_list_resource=episode_file_list_resource)
    except Exception as e:
        print("Exception when calling EpisodeFileApi->put_episode_file_editor: %s\n" % e)
```

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

### Create MediaInfoResource from JSON and Dict

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

Demonstrates how to create a MediaInfoResource instance from a JSON string or a dictionary, and how to convert it back to a dictionary. Requires the MediaInfoResource model.

```python
from whisparr.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)
```

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

### Configure and Use AlternativeTitleApi

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

Example of configuring the API client with an API key and making a request to the AlternativeTitleApi. Ensure your API key is set as an environment variable.

```python
import whisparr
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.AlternativeTitleApi(api_client)
    id = 56 # int | 

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

```

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

### Get Delay Profile by ID

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

Retrieves a specific delay profile by its ID. This example demonstrates setting up the API client configuration, including API key authentication, and handling the API response or exceptions.

```python
import whisparr
from whisparr.models.delay_profile_resource import DelayProfileResource
from whisparr.rest import ApiException
from pprint import pprint

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

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

with whisparr.ApiClient(configuration) as api_client:
    api_instance = whisparr.DelayProfileApi(api_client)
    id = 56
    try:
        api_response = api_instance.get_delay_profile_by_id(id)
        print("The response of DelayProfileApi->get_delay_profile_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DelayProfileApi->get_delay_profile_by_id: %s\n" % e)
```

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

### Instantiate CommandResource from JSON and Dict

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/CommandResource.md

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

```python
from whisparr.models.command_resource import CommandResource

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

# convert the object into a dict
command_resource_dict = command_resource_instance.to_dict()
# create an instance of CommandResource from a dict
command_resource_from_dict = CommandResource.from_dict(command_resource_dict)
```

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

### Get Media Cover by Filename using MediaCoverApi

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/MediaCoverApi.md

Demonstrates how to retrieve a media cover by its movie ID and filename using the Whisparr Python client. Includes setup for API key authentication (apikey and X-Api-Key).

```python
import whisparr
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.MediaCoverApi(api_client)
    movie_id = 56 # int | 
    filename = 'filename_example' # str | 

    try:
        api_instance.get_media_cover_by_filename(movie_id, filename)
    except Exception as e:
        print("Exception when calling MediaCoverApi->get_media_cover_by_filename: %s\n" % e)

```

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

### Instantiate RootFolderResource from JSON and Dict

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/RootFolderResource.md

Demonstrates creating a RootFolderResource instance from a JSON string and a dictionary. Also shows converting an instance back to a dictionary and printing its JSON representation. Ensure the JSON string is valid.

```python
from whisparr.models.root_folder_resource import RootFolderResource

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

# convert the object into a dict
root_folder_resource_dict = root_folder_resource_instance.to_dict()
# create an instance of RootFolderResource from a dict
root_folder_resource_from_dict = RootFolderResource.from_dict(root_folder_resource_dict)
```

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

### Create Release Profile - Python

Source: https://github.com/devopsarr/whisparr-py/blob/main/docs/ReleaseProfileApi.md

Use this snippet to create a new release profile. It demonstrates setting up the API client, configuring authentication, and making the POST request. Ensure you have the 'API_KEY' environment variable set for authentication.

```python
import whisparr
from whisparr.models.release_profile_resource import ReleaseProfileResource
from whisparr.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 = whisparr.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 whisparr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whisparr.ReleaseProfileApi(api_client)
    release_profile_resource = whisparr.ReleaseProfileResource() # ReleaseProfileResource |  (optional)

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