Skip to content

CreditApi.md

Latest commit

 

History

History
171 lines (115 loc) · 5.06 KB

CreditApi.md

File metadata and controls

171 lines (115 loc) · 5.06 KB

whisparr.CreditApi

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

Method HTTP request Description
get_credit GET /api/v3/credit
get_credit_by_id GET /api/v3/credit/{id}

get_credit

get_credit(movie_id=movie_id, movie_metadata_id=movie_metadata_id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
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.CreditApi(api_client)
    movie_id = 56 # int |  (optional)
    movie_metadata_id = 56 # int |  (optional)

    try:
        api_instance.get_credit(movie_id=movie_id, movie_metadata_id=movie_metadata_id)
    except Exception as e:
        print("Exception when calling CreditApi->get_credit: %s\n" % e)

Parameters

Name Type Description Notes
movie_id int [optional]
movie_metadata_id int [optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
2XX Success -

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

get_credit_by_id

CreditResource get_credit_by_id(id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import whisparr
from whisparr.models.credit_resource import CreditResource
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.CreditApi(api_client)
    id = 56 # int | 

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

Parameters

Name Type Description Notes
id int

Return type

CreditResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

HTTP response details

Status code Description Response headers
2XX Success -

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