# 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 Global Hubs * [get_recently_added](#get_recently_added) - Get Recently Added * [get_library_hubs](#get_library_hubs) - Get library specific hubs ## get_global_hubs Get Global Hubs filtered by the parameters provided. ### Example Usage ```python from plex_api_client import PlexAPI with PlexAPI( access_token="", ) 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]* | :heavy_minus_sign: | The number of items to return with each hub. | | `only_transient` | [Optional[operations.OnlyTransient]](../../models/operations/onlytransient.md) | :heavy_minus_sign: | 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]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response **[operations.GetGlobalHubsResponse](../../models/operations/getglobalhubsresponse.md)** ### 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 ```python from plex_api_client import PlexAPI from plex_api_client.models import operations with PlexAPI( access_token="", ) as plex_api: res = plex_api.hubs.get_recently_added(request={ "content_directory_id": 39486, "section_id": 2, "type": operations.Type.TV_SHOW, "include_meta": operations.IncludeMeta.ENABLE, }) assert res.object is not None # Handle response print(res.object) ``` ### Parameters | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `request` | [operations.GetRecentlyAddedRequest](../../models/operations/getrecentlyaddedrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response **[operations.GetRecentlyAddedResponse](../../models/operations/getrecentlyaddedresponse.md)** ### 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 ```python from plex_api_client import PlexAPI with PlexAPI( access_token="", ) as plex_api: res = plex_api.hubs.get_library_hubs(section_id=492.74) assert res.object is not None # Handle response print(res.object) ``` ### Parameters | Parameter | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `section_id` | *float* | :heavy_check_mark: | the Id of the library to query | | `count` | *Optional[float]* | :heavy_minus_sign: | The number of items to return with each hub. | | `only_transient` | [Optional[operations.QueryParamOnlyTransient]](../../models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | 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]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response **[operations.GetLibraryHubsResponse](../../models/operations/getlibraryhubsresponse.md)** ### Errors | Error Type | Status Code | Content Type | | --------------------------------- | --------------------------------- | --------------------------------- | | errors.GetLibraryHubsBadRequest | 400 | application/json | | errors.GetLibraryHubsUnauthorized | 401 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* |