plexpy/docs/sdks/hubs/README.md

Hubs

(hubs)

Overview

The hubs within a media provider

Available Operations

• get_all_hubs - Get global hubs
• get_continue_watching - Get the continue watching hub
• get_hub_items - Get a hub's items
• get_promoted_hubs - Get the hubs which are promoted
• get_metadata_hubs - Get hubs for section by metadata item
• get_postplay_hubs - Get postplay hubs
• get_related_hubs - Get related hubs
• get_section_hubs - Get section hubs
• reset_section_defaults - Reset hubs to defaults
• list_hubs - Get hubs
• create_custom_hub - Create a custom hub
• move_hub - Move Hub
• delete_custom_hub - Delete a custom hub
• update_hub_visibility - Change hub visibility

get_all_hubs

Get the global hubs in this PMS

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.hubs.get_all_hubs(request={
        "only_transient": components.BoolInt.TRUE,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetAllHubsResponse

Errors

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

get_continue_watching

Get the global continue watching hub

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.hubs.get_continue_watching(request={})

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetContinueWatchingResponse

Errors

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

get_hub_items

Get the items within a single hub specified by identifier

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.hubs.get_hub_items(request={
        "identifier": [
            "<value 1>",
            "<value 2>",
            "<value 3>",
        ],
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetHubItemsResponse

Errors

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

get_promoted_hubs

Get the global hubs which are promoted (should be displayed on the home screen)

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.hubs.get_promoted_hubs(request={})

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetPromotedHubsResponse

Errors

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

get_metadata_hubs

Get the hubs for a section by metadata item. Currently only for music sections

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.hubs.get_metadata_hubs(request={
        "metadata_id": 605482,
        "only_transient": components.BoolInt.TRUE,
    })

    assert res.media_container_with_hubs is not None

    # Handle response
    print(res.media_container_with_hubs)

Parameters

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

Response

operations.GetMetadataHubsResponse

Errors

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

get_postplay_hubs

Get the hubs for a metadata to be displayed in post play

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.hubs.get_postplay_hubs(request={
        "metadata_id": 441419,
        "only_transient": components.BoolInt.TRUE,
    })

    assert res.media_container_with_hubs is not None

    # Handle response
    print(res.media_container_with_hubs)

Parameters

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

Response

operations.GetPostplayHubsResponse

Errors

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

get_related_hubs

Get the hubs for a metadata related to the provided metadata item

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.hubs.get_related_hubs(request={
        "metadata_id": 8858,
        "only_transient": components.BoolInt.TRUE,
    })

    assert res.media_container_with_hubs is not None

    # Handle response
    print(res.media_container_with_hubs)

Parameters

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

Response

operations.GetRelatedHubsResponse

Errors

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

get_section_hubs

Get the hubs for a single section

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.hubs.get_section_hubs(request={
        "section_id": 336924,
        "only_transient": components.BoolInt.TRUE,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetSectionHubsResponse

Errors

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

reset_section_defaults

Reset hubs for this section to defaults and delete custom hubs

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.hubs.reset_section_defaults(request={
        "section_id": 383022,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.ResetSectionDefaultsResponse

Errors

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

list_hubs

Get the list of hubs including both built-in and custom

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.hubs.list_hubs(request={
        "section_id": 442546,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.ListHubsResponse

Errors

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

create_custom_hub

Create a custom hub based on a metadata item

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.hubs.create_custom_hub(request=operations.CreateCustomHubRequest(
        section_id=869922,
        metadata_item_id=703843,
        promoted_to_recommended=components.BoolInt.TRUE,
        promoted_to_own_home=components.BoolInt.TRUE,
        promoted_to_shared_home=components.BoolInt.TRUE,
    ))

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.CreateCustomHubResponse

Errors

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

move_hub

Changed the ordering of a hub among others hubs

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.hubs.move_hub(request={
        "section_id": 755710,
        "identifier": "<value>",
    })

    assert res.get_responses_200 is not None

    # Handle response
    print(res.get_responses_200)

Parameters

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

Response

operations.MoveHubResponse

Errors

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

delete_custom_hub

Delete a custom hub from the server

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.hubs.delete_custom_hub(request={
        "section_id": 625677,
        "identifier": "<value>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.DeleteCustomHubResponse

Errors

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

update_hub_visibility

Changed the visibility of a hub for both the admin and shared users

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.hubs.update_hub_visibility(request=operations.UpdateHubVisibilityRequest(
        section_id=341650,
        identifier="<value>",
        promoted_to_recommended=components.BoolInt.TRUE,
        promoted_to_own_home=components.BoolInt.TRUE,
        promoted_to_shared_home=components.BoolInt.TRUE,
    ))

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.UpdateHubVisibilityResponse

Errors

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