plexpy/docs/sdks/hubs/README.md

Hubs

(hubs)

Overview

Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.

Available Operations

• get_global_hubs - Get Global Hubs
• get_recently_added - Get Recently Added
• get_library_hubs - Get library specific hubs

get_global_hubs

Get Global Hubs filtered by the parameters provided.

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.hubs.get_global_hubs()

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
count	Optional[float]	➖	The number of items to return with each hub.
only_transient	Optional[operations.OnlyTransient]	➖	Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetGlobalHubsResponse

Errors

Error Type	Status Code	Content Type
errors.GetGlobalHubsBadRequest	400	application/json
errors.GetGlobalHubsUnauthorized	401	application/json
errors.SDKError	4XX, 5XX	*/*

get_recently_added

This endpoint will return the recently added content.

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import operations

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

    res = plex_api.hubs.get_recently_added(request={
        "content_directory_id": 470161,
        "type": operations.Type.TV_SHOW,
        "section_id": 2,
        "include_meta": operations.IncludeMeta.ENABLE,
        "x_plex_container_start": 0,
        "x_plex_container_size": 50,
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

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

Response

operations.GetRecentlyAddedResponse

Errors

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

get_library_hubs

This endpoint will return a list of library specific hubs

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.hubs.get_library_hubs(section_id=6728.76)

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
section_id	float	✔️	the Id of the library to query
count	Optional[float]	➖	The number of items to return with each hub.
only_transient	Optional[operations.QueryParamOnlyTransient]	➖	Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetLibraryHubsResponse

Errors

Error Type	Status Code	Content Type
errors.GetLibraryHubsBadRequest	400	application/json
errors.GetLibraryHubsUnauthorized	401	application/json
errors.SDKError	4XX, 5XX	*/*