LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-10 12:37:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial Commit

Browse Source
This commit is contained in:
Luke Hagar
2024-01-01 15:47:37 -06:00
parent 203c48ae7c
commit f91c1e6f54
4519 changed files with 88021 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
content/pages/01-reference/python/resources/hubs/get_global_hubs/_header.mdx Normal file
View File

@@ -0,0 +1,3 @@
## Get Global Hubs
Get Global Hubs filtered by the parameters provided.

16
content/pages/01-reference/python/resources/hubs/get_global_hubs/_parameters.mdx Normal file
View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import OnlyTransient from "/content/types/models/operations/only_transient/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `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).
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<OnlyTransient/>
</Collapsible>

11
content/pages/01-reference/python/resources/hubs/get_global_hubs/_response.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
import GetGlobalHubsResponse from "/content/types/models/operations/get_global_hubs_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetGlobalHubsResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetGlobalHubsResponse/>
</Collapsible>

31
content/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx Normal file
View File

@@ -0,0 +1,31 @@
<CH.Code>
```python GetGlobalHubs.py
import sdk
from sdk.models import operations
s = sdk.SDK(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.hubs.get_global_hubs(count=8472.52, only_transient=operations.OnlyTransient.ZERO)
if res.status_code == 200:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/python/resources/hubs/get_global_hubs/get_global_hubs.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Hubs*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

3
content/pages/01-reference/python/resources/hubs/get_library_hubs/_header.mdx Normal file
View File

@@ -0,0 +1,3 @@
## Get Library Hubs
This endpoint will return a list of library specific hubs

20
content/pages/01-reference/python/resources/hubs/get_library_hubs/_parameters.mdx Normal file
View File

@@ -0,0 +1,20 @@
{/* Autogenerated DO NOT EDIT */}
import QueryParamOnlyTransient from "/content/types/models/operations/query_param_only_transient/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `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).
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<QueryParamOnlyTransient/>
</Collapsible>

11
content/pages/01-reference/python/resources/hubs/get_library_hubs/_response.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
import GetLibraryHubsResponse from "/content/types/models/operations/get_library_hubs_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetLibraryHubsResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLibraryHubsResponse/>
</Collapsible>

31
content/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx Normal file
View File

@@ -0,0 +1,31 @@
<CH.Code>
```python GetLibraryHubs.py
import sdk
from sdk.models import operations
s = sdk.SDK(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.hubs.get_library_hubs(section_id=6235.64, count=6458.94, only_transient=operations.QueryParamOnlyTransient.ZERO)
if res.status_code == 200:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/python/resources/hubs/get_library_hubs/get_library_hubs.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Hubs*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

17
content/pages/01-reference/python/resources/hubs/hubs.mdx Normal file
View File

@@ -0,0 +1,17 @@
import GetGlobalHubs from "./get_global_hubs/get_global_hubs.mdx";
import GetLibraryHubs from "./get_library_hubs/get_library_hubs.mdx";
## Hubs
Hubs are a structured two\-dimensional container for media, generally represented by multiple horizontal rows.
### Available Operations
* [Get Global Hubs](/python/hubs/get_global_hubs) - Get Global Hubs
* [Get Library Hubs](/python/hubs/get_library_hubs) - Get library specific hubs
---
<GetGlobalHubs />
---
<GetLibraryHubs />