plexpy/docs/sdks/subscriptions/README.md

Subscriptions

(subscriptions)

Overview

Subscriptions determine which media will be recorded and the criteria for selecting an airing when multiple are available

Available Operations

• get_all_subscriptions - Get all subscriptions
• create_subscription - Create a subscription
• process_subscriptions - Process all subscriptions
• get_scheduled_recordings - Get all scheduled recordings
• get_template - Get the subscription template
• cancel_grab - Cancel an existing grab
• delete_subscription - Delete a subscription
• get_subscription - Get a single subscription
• edit_subscription_preferences - Edit a subscription
• reorder_subscription - Re-order a subscription

get_all_subscriptions

Get all subscriptions and potentially the grabs too

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components, operations


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.get_all_subscriptions(request=operations.GetAllSubscriptionsRequest(
        include_grabs=components.BoolInt.TRUE,
        include_storage=components.BoolInt.TRUE,
    ))

    assert res.media_container_with_subscription is not None

    # Handle response
    print(res.media_container_with_subscription)

Parameters

Parameter	Type	Required	Description
request	operations.GetAllSubscriptionsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetAllSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

create_subscription

Create a subscription. The query parameters should be mostly derived from the template

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.create_subscription(request={
        "target_library_section_id": 1,
        "target_section_location_id": 3,
        "type": 2,
        "hints": {},
        "prefs": {},
        "params": {},
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.CreateSubscriptionRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateSubscriptionResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

process_subscriptions

Process all subscriptions asynchronously

Example Usage

from plex_api_client import PlexAPI


with PlexAPI(
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.process_subscriptions()

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ProcessSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_scheduled_recordings

Get all scheduled recordings across all subscriptions

Example Usage

from plex_api_client import PlexAPI


with PlexAPI(
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.get_scheduled_recordings()

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetScheduledRecordingsResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_template

Get the templates for a piece of media which could include fetching one airing, season, the whole show, etc.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.get_template(request={
        "guid": "plex://episode/5fc70265c40548002d539d23",
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.GetTemplateRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetTemplateResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

cancel_grab

Cancels an existing media grab (recording). It can be used to resolve a conflict which exists for a rolling subscription. Note: This cancellation does not persist across a server restart, but neither does a rolling subscription itself.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.cancel_grab(request={
        "operation_id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.CancelGrabRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CancelGrabResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

delete_subscription

Delete a subscription, cancelling all of its grabs as well

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.delete_subscription(request={
        "subscription_id": 974618,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.DeleteSubscriptionRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DeleteSubscriptionResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_subscription

Get a single subscription and potentially the grabs too

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components, operations


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.get_subscription(request=operations.GetSubscriptionRequest(
        subscription_id=186713,
        include_grabs=components.BoolInt.TRUE,
        include_storage=components.BoolInt.TRUE,
    ))

    assert res.media_container_with_subscription is not None

    # Handle response
    print(res.media_container_with_subscription)

Parameters

Parameter	Type	Required	Description
request	operations.GetSubscriptionRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetSubscriptionResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

edit_subscription_preferences

Edit a subscription's preferences

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.edit_subscription_preferences(request={
        "subscription_id": 673918,
        "prefs": {},
    })

    assert res.media_container_with_subscription is not None

    # Handle response
    print(res.media_container_with_subscription)

Parameters

Parameter	Type	Required	Description
request	operations.EditSubscriptionPreferencesRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.EditSubscriptionPreferencesResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

reorder_subscription

Re-order a subscription to change its priority

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import components


with PlexAPI(
    accepts=components.Accepts.APPLICATION_XML,
    client_identifier="abc123",
    product="Plex for Roku",
    version="2.4.1",
    platform="Roku",
    platform_version="4.3 build 1057",
    device="Roku 3",
    model="4200X",
    device_vendor="Roku",
    device_name="Living Room TV",
    marketplace="googlePlay",
    token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.subscriptions.reorder_subscription(request={
        "subscription_id": 440634,
    })

    assert res.media_container_with_subscription is not None

    # Handle response
    print(res.media_container_with_subscription)

Parameters

Parameter	Type	Required	Description
request	operations.ReorderSubscriptionRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ReorderSubscriptionResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*