mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-06 20:47:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.0
This commit is contained in:
speakeasybot
@@ -1,23 +0,0 @@
|
||||
import GetServerActivities from "./get_server_activities/get_server_activities.mdx";
|
||||
import CancelServerActivities from "./cancel_server_activities/cancel_server_activities.mdx";
|
||||
|
||||
## Activities
|
||||
Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real\-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
||||
Activities are associated with HTTP replies via a special `X\-Plex\-Activity` header which contains the UUID of the activity.
|
||||
Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details:
|
||||
\- They can contain a `progress` (from 0 to 100) marking the percent completion of the activity.
|
||||
\- They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||
\- They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||
\- The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Server Activities](/python/activities/get_server_activities) - Get Server Activities
|
||||
* [Cancel Server Activities](/python/activities/cancel_server_activities) - Cancel Server Activities
|
||||
|
||||
---
|
||||
<GetServerActivities />
|
||||
|
||||
---
|
||||
<CancelServerActivities />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Cancel Server Activities
|
||||
|
||||
Cancel Server Activities
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `activity_uuid` *{`str`}*
|
||||
The UUID of the activity to cancel.
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import CancelServerActivitiesResponse from "/content/types/models/operations/cancel_server_activities_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.CancelServerActivitiesResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<CancelServerActivitiesResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python CancelServerActivities.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.activities.cancel_server_activities(activity_uuid='string')
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Activities*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Server Activities
|
||||
|
||||
Get Server Activities
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetServerActivitiesResponse from "/content/types/models/operations/get_server_activities_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetServerActivitiesResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetServerActivitiesResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetServerActivities.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.activities.get_server_activities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 6235.64,
|
||||
"Activity": [
|
||||
{
|
||||
"uuid": "string",
|
||||
"type": "string",
|
||||
"cancellable": false,
|
||||
"userID": 6458.94,
|
||||
"title": "string",
|
||||
"subtitle": "string",
|
||||
"progress": 3843.82,
|
||||
"Context": {
|
||||
"librarySectionID": "string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,32 +0,0 @@
|
||||
import GetButlerTasks from "./get_butler_tasks/get_butler_tasks.mdx";
|
||||
import StartAllTasks from "./start_all_tasks/start_all_tasks.mdx";
|
||||
import StopAllTasks from "./stop_all_tasks/stop_all_tasks.mdx";
|
||||
import StartTask from "./start_task/start_task.mdx";
|
||||
import StopTask from "./stop_task/stop_task.mdx";
|
||||
|
||||
## Butler
|
||||
Butler is the task manager of the Plex Media Server Ecosystem.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Butler Tasks](/python/butler/get_butler_tasks) - Get Butler tasks
|
||||
* [Start All Tasks](/python/butler/start_all_tasks) - Start all Butler tasks
|
||||
* [Stop All Tasks](/python/butler/stop_all_tasks) - Stop all Butler tasks
|
||||
* [Start Task](/python/butler/start_task) - Start a single Butler task
|
||||
* [Stop Task](/python/butler/stop_task) - Stop a single Butler task
|
||||
|
||||
---
|
||||
<GetButlerTasks />
|
||||
|
||||
---
|
||||
<StartAllTasks />
|
||||
|
||||
---
|
||||
<StopAllTasks />
|
||||
|
||||
---
|
||||
<StartTask />
|
||||
|
||||
---
|
||||
<StopTask />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Butler Tasks
|
||||
|
||||
Returns a list of butler tasks
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetButlerTasksResponse from "/content/types/models/operations/get_butler_tasks_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetButlerTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetButlerTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetButlerTasks.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.butler.get_butler_tasks()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"ButlerTasks": {
|
||||
"ButlerTask": [
|
||||
{
|
||||
"name": "BackupDatabase",
|
||||
"interval": 3,
|
||||
"scheduleRandomized": false,
|
||||
"enabled": false,
|
||||
"title": "Backup Database",
|
||||
"description": "Create a backup copy of the server's database in the configured backup directory"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,7 +0,0 @@
|
||||
## Start All Tasks
|
||||
|
||||
This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||
1. Any tasks not scheduled to run on the current day will be skipped.
|
||||
2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||
3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||
4. If we are outside the configured window, the task will start immediately.
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StartAllTasksResponse from "/content/types/models/operations/start_all_tasks_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.StartAllTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StartAllTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python StartAllTasks.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.butler.start_all_tasks()
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,7 +0,0 @@
|
||||
## Start Task
|
||||
|
||||
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||
1. Any tasks not scheduled to run on the current day will be skipped.
|
||||
2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||
3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||
4. If we are outside the configured window, the task will start immediately.
|
||||
@@ -1,12 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import TaskName from "/content/types/models/operations/task_name/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `task_name` *{`operations.TaskName`}*
|
||||
the name of the task to be started.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<TaskName />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StartTaskResponse from "/content/types/models/operations/start_task_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.StartTaskResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StartTaskResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python StartTask.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.butler.start_task(task_name=operations.TaskName.REFRESH_PERIODIC_METADATA)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Stop All Tasks
|
||||
|
||||
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StopAllTasksResponse from "/content/types/models/operations/stop_all_tasks_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.StopAllTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StopAllTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python StopAllTasks.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.butler.stop_all_tasks()
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Stop Task
|
||||
|
||||
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
||||
@@ -1,12 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import PathParamTaskName from "/content/types/models/operations/path_param_task_name/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `task_name` *{`operations.PathParamTaskName`}*
|
||||
The name of the task to be started.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<PathParamTaskName />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StopTaskResponse from "/content/types/models/operations/stop_task_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.StopTaskResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StopTaskResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python StopTask.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.butler.stop_task(task_name=operations.PathParamTaskName.GENERATE_CHAPTER_THUMBS)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Global Hubs
|
||||
|
||||
Get Global Hubs filtered by the parameters provided.
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* 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>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* 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>
|
||||
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetGlobalHubs.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.hubs.get_global_hubs(count=8472.52, only_transient=operations.OnlyTransient.ZERO)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 8,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"Hub": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Hubs*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Library Hubs
|
||||
|
||||
This endpoint will return a list of library specific hubs
|
||||
@@ -1,20 +0,0 @@
|
||||
{/* 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>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* 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>
|
||||
|
||||
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetLibraryHubs.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
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.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 7,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"Hub": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Hubs*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,17 +0,0 @@
|
||||
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 />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Delete Library
|
||||
|
||||
Delate a library using a specific section
|
||||
@@ -1,6 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python DeleteLibrary.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.delete_library(section_id=1000)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get File Hash
|
||||
|
||||
This resource returns hash values for local files
|
||||
@@ -1,10 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `url` *{`str`}*
|
||||
This is the path to the local file, must be prefixed by `file://`
|
||||
<br/>
|
||||
**Example:** `file://C:\Image.png&type=13`
|
||||
|
||||
---
|
||||
##### `type` *{`Optional[float]`}*
|
||||
Item type
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetFileHashResponse from "/content/types/models/operations/get_file_hash_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetFileHashResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetFileHashResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetFileHash.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_file_hash(url='file://C:\Image.png&type=13', type=567.13)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,8 +0,0 @@
|
||||
## Get Libraries
|
||||
|
||||
A library section (commonly referred to as just a library) is a collection of media.
|
||||
Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media.
|
||||
For example, a music library has an artist > albums > tracks structure, whereas a movie library is flat.
|
||||
|
||||
Libraries have features beyond just being a collection of media; for starters, they include information about supported types, filters and sorts.
|
||||
This allows a client to provide a rich interface around the media (e.g. allow sorting movies by release year).
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetLibrariesResponse from "/content/types/models/operations/get_libraries_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetLibrariesResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetLibrariesResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,41 +0,0 @@
|
||||
## Get Library
|
||||
|
||||
## Library Details Endpoint
|
||||
|
||||
This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
|
||||
The details include:
|
||||
|
||||
### Directories
|
||||
Organized into three categories:
|
||||
|
||||
- **Primary Directories**:
|
||||
- Used in some clients for quick access to media subsets (e.g., "All", "On Deck").
|
||||
- Most can be replicated via media queries.
|
||||
- Customizable by users.
|
||||
|
||||
- **Secondary Directories**:
|
||||
- Marked with `secondary="1"`.
|
||||
- Used in older clients for structured navigation.
|
||||
|
||||
- **Special Directories**:
|
||||
- Includes a "By Folder" entry for filesystem-based browsing.
|
||||
- Contains an obsolete `search="1"` entry for on-the-fly search dialog creation.
|
||||
|
||||
### Types
|
||||
Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls:
|
||||
|
||||
- **Type Object Attributes**:
|
||||
- `key`: Endpoint for the media list of this type.
|
||||
- `type`: Metadata type (if standard Plex type).
|
||||
- `title`: Title for this content type (e.g., "Movies").
|
||||
|
||||
- **Filter Objects**:
|
||||
- Subset of the media query language.
|
||||
- Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`.
|
||||
|
||||
- **Sort Objects**:
|
||||
- Description of sort fields.
|
||||
- Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`.
|
||||
|
||||
> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.
|
||||
@@ -1,20 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import IncludeDetails from "/content/types/models/operations/include_details/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `include_details` *{`Optional[operations.IncludeDetails]`}*
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<IncludeDetails />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetLibraryResponse from "/content/types/models/operations/get_library_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetLibraryResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetLibraryResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetLibrary.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ONE)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 29,
|
||||
"allowSync": false,
|
||||
"art": "/:/resources/movie-fanart.jpg",
|
||||
"content": "secondary",
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1701731894,
|
||||
"thumb": "/:/resources/movie.png",
|
||||
"title1": "Movies",
|
||||
"viewGroup": "secondary",
|
||||
"viewMode": 65592,
|
||||
"Directory": [],
|
||||
"Type": [],
|
||||
"FieldType": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,22 +0,0 @@
|
||||
## Get Library Items
|
||||
|
||||
Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
|
||||
- `all`: All items in the section.
|
||||
- `unwatched`: Items that have not been played.
|
||||
- `newest`: Items that are recently released.
|
||||
- `recentlyAdded`: Items that are recently added to the library.
|
||||
- `recentlyViewed`: Items that were recently viewed.
|
||||
- `onDeck`: Items to continue watching.
|
||||
- `collection`: Items categorized by collection.
|
||||
- `edition`: Items categorized by edition.
|
||||
- `genre`: Items categorized by genre.
|
||||
- `year`: Items categorized by year of release.
|
||||
- `decade`: Items categorized by decade.
|
||||
- `director`: Items categorized by director.
|
||||
- `actor`: Items categorized by starring actor.
|
||||
- `country`: Items categorized by country of origin.
|
||||
- `contentRating`: Items categorized by content rating.
|
||||
- `rating`: Items categorized by rating.
|
||||
- `resolution`: Items categorized by resolution.
|
||||
- `firstCharacter`: Items categorized by the first letter.
|
||||
- `folder`: Items categorized by folder.
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Tag from "/content/types/models/operations/tag/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `section_id` *{`int`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `tag` *{`operations.Tag`}*
|
||||
A key representing a specific tag within the section.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Tag />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetLibraryItemsResponse from "/content/types/models/operations/get_library_items_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetLibraryItemsResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetLibraryItemsResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetLibraryItems.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_library_items(section_id=272656, tag=operations.Tag.EDITION)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 70,
|
||||
"allowSync": true,
|
||||
"art": "/:/resources/movie-fanart.jpg",
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1701731894,
|
||||
"thumb": "/:/resources/movie.png",
|
||||
"title1": "Movies",
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Metadata
|
||||
|
||||
This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `rating_key` *{`float`}*
|
||||
the id of the library item to return the children of.
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetMetadataResponse from "/content/types/models/operations/get_metadata_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetMetadataResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetMetadataResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetMetadata.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_metadata(rating_key=5288.95)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 1,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1698860922,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Metadata Children
|
||||
|
||||
This endpoint will return the children of of a library item specified with the ratingKey.
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `rating_key` *{`float`}*
|
||||
the id of the library item to return the children of.
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetMetadataChildrenResponse from "/content/types/models/operations/get_metadata_children_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetMetadataChildrenResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetMetadataChildrenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetMetadataChildren.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_metadata_children(rating_key=4799.77)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 3,
|
||||
"allowSync": true,
|
||||
"art": "/library/metadata/30072/art/1705739923",
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"key": "30072",
|
||||
"librarySectionID": 2,
|
||||
"librarySectionTitle": "TV Shows",
|
||||
"librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1701731894,
|
||||
"nocache": true,
|
||||
"parentIndex": 1,
|
||||
"parentTitle": "Reacher",
|
||||
"parentYear": 2022,
|
||||
"summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.",
|
||||
"theme": "/library/metadata/30072/theme/1705739923",
|
||||
"thumb": "/library/metadata/30072/thumb/1705739923",
|
||||
"title1": "TV Shows",
|
||||
"title2": "Reacher",
|
||||
"viewGroup": "season",
|
||||
"viewMode": 65593,
|
||||
"Directory": [],
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get On Deck
|
||||
|
||||
This endpoint will return the on deck content.
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetOnDeckResponse from "/content/types/models/operations/get_on_deck_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetOnDeckResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetOnDeckResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,131 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetOnDeck.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_on_deck()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 16,
|
||||
"allowSync": false,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1680021154,
|
||||
"mixedParents": false,
|
||||
"Metadata": [
|
||||
{
|
||||
"allowSync": false,
|
||||
"librarySectionID": 2,
|
||||
"librarySectionTitle": "TV Shows",
|
||||
"librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
"ratingKey": 49564,
|
||||
"key": "/library/metadata/49564",
|
||||
"parentRatingKey": 49557,
|
||||
"grandparentRatingKey": 49556,
|
||||
"guid": "plex://episode/5ea7d7402e7ab10042e74d4f",
|
||||
"parentGuid": "plex://season/602e754d67f4c8002ce54b3d",
|
||||
"grandparentGuid": "plex://show/5d9c090e705e7a001e6e94d8",
|
||||
"type": "episode",
|
||||
"title": "Circus",
|
||||
"grandparentKey": "/library/metadata/49556",
|
||||
"parentKey": "/library/metadata/49557",
|
||||
"librarySectionKey": "/library/sections/2",
|
||||
"grandparentTitle": "Bluey (2018)",
|
||||
"parentTitle": "Season 2",
|
||||
"contentRating": "TV-Y",
|
||||
"summary": "Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
|
||||
"index": 33,
|
||||
"parentIndex": 2,
|
||||
"lastViewedAt": 1681908352,
|
||||
"year": 2018,
|
||||
"thumb": "/library/metadata/49564/thumb/1654258204",
|
||||
"art": "/library/metadata/49556/art/1680939546",
|
||||
"parentThumb": "/library/metadata/49557/thumb/1654258204",
|
||||
"grandparentThumb": "/library/metadata/49556/thumb/1680939546",
|
||||
"grandparentArt": "/library/metadata/49556/art/1680939546",
|
||||
"grandparentTheme": "/library/metadata/49556/theme/1680939546",
|
||||
"duration": 420080,
|
||||
"originallyAvailableAt": "2020-10-31T00:00:00Z",
|
||||
"addedAt": 1654258196,
|
||||
"updatedAt": 1654258204,
|
||||
"Media": [
|
||||
{
|
||||
"id": 80994,
|
||||
"duration": 420080,
|
||||
"bitrate": 1046,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"aspectRatio": 1.78,
|
||||
"audioChannels": 2,
|
||||
"audioCodec": "aac",
|
||||
"videoCodec": "hevc",
|
||||
"videoResolution": "1080",
|
||||
"container": "mkv",
|
||||
"videoFrameRate": "PAL",
|
||||
"audioProfile": "lc",
|
||||
"videoProfile": "main",
|
||||
"Part": [
|
||||
{
|
||||
"id": 80994,
|
||||
"key": "/library/parts/80994/1655007810/file.mkv",
|
||||
"duration": 420080,
|
||||
"file": "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
"size": 55148931,
|
||||
"audioProfile": "lc",
|
||||
"container": "mkv",
|
||||
"videoProfile": "main",
|
||||
"Stream": [
|
||||
{
|
||||
"id": 211234,
|
||||
"streamType": 1,
|
||||
"default": false,
|
||||
"codec": "hevc",
|
||||
"index": 0,
|
||||
"bitrate": 918,
|
||||
"language": "English",
|
||||
"languageTag": "en",
|
||||
"languageCode": "eng",
|
||||
"bitDepth": 8,
|
||||
"chromaLocation": "left",
|
||||
"chromaSubsampling": "4:2:0",
|
||||
"codedHeight": 1080,
|
||||
"codedWidth": 1920,
|
||||
"colorRange": "tv",
|
||||
"frameRate": 25,
|
||||
"height": 1080,
|
||||
"level": 120,
|
||||
"profile": "main",
|
||||
"refFrames": 1,
|
||||
"width": 1920,
|
||||
"displayTitle": "1080p (HEVC Main)",
|
||||
"extendedDisplayTitle": "1080p (HEVC Main)"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"guids": [
|
||||
{
|
||||
"id": "imdb://tt13303712"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Recently Added
|
||||
|
||||
This endpoint will return the recently added content.
|
||||
@@ -1,2 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetRecentlyAddedResponse from "/content/types/models/operations/get_recently_added_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetRecentlyAddedResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetRecentlyAddedResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,119 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetRecentlyAdded.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_recently_added()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 50,
|
||||
"allowSync": false,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1680021154,
|
||||
"mixedParents": false,
|
||||
"Metadata": [
|
||||
{
|
||||
"allowSync": false,
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"ratingKey": 59398,
|
||||
"key": "/library/metadata/59398",
|
||||
"guid": "plex://movie/5e161a83bea6ac004126e148",
|
||||
"studio": "Marvel Studios",
|
||||
"type": "movie",
|
||||
"title": "Ant-Man and the Wasp: Quantumania",
|
||||
"contentRating": "PG-13",
|
||||
"summary": "Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible.",
|
||||
"rating": 4.7,
|
||||
"audienceRating": 8.3,
|
||||
"year": 2023,
|
||||
"tagline": "Witness the beginning of a new dynasty.",
|
||||
"thumb": "/library/metadata/59398/thumb/1681888010",
|
||||
"art": "/library/metadata/59398/art/1681888010",
|
||||
"duration": 7474422,
|
||||
"originallyAvailableAt": "2023-02-15T00:00:00Z",
|
||||
"addedAt": 1681803215,
|
||||
"updatedAt": 1681888010,
|
||||
"audienceRatingImage": "rottentomatoes://image.rating.upright",
|
||||
"chapterSource": "media",
|
||||
"primaryExtraKey": "/library/metadata/59399",
|
||||
"ratingImage": "rottentomatoes://image.rating.rotten",
|
||||
"Media": [
|
||||
{
|
||||
"id": 120345,
|
||||
"duration": 7474422,
|
||||
"bitrate": 3623,
|
||||
"width": 1920,
|
||||
"height": 804,
|
||||
"aspectRatio": 2.35,
|
||||
"audioChannels": 6,
|
||||
"audioCodec": "ac3",
|
||||
"videoCodec": "h264",
|
||||
"videoResolution": 1080,
|
||||
"container": "mp4",
|
||||
"videoFrameRate": "24p",
|
||||
"optimizedForStreaming": 0,
|
||||
"has64bitOffsets": false,
|
||||
"videoProfile": "high",
|
||||
"Part": [
|
||||
{
|
||||
"id": 120353,
|
||||
"key": "/library/parts/120353/1681803203/file.mp4",
|
||||
"duration": 7474422,
|
||||
"file": "/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4",
|
||||
"size": 3395307162,
|
||||
"container": "mp4",
|
||||
"has64bitOffsets": false,
|
||||
"hasThumbnail": 1,
|
||||
"optimizedForStreaming": false,
|
||||
"videoProfile": "high"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Genre": [
|
||||
{
|
||||
"tag": "Comedy"
|
||||
}
|
||||
],
|
||||
"Director": [
|
||||
{
|
||||
"tag": "Peyton Reed"
|
||||
}
|
||||
],
|
||||
"Writer": [
|
||||
{
|
||||
"tag": "Jeff Loveness"
|
||||
}
|
||||
],
|
||||
"Country": [
|
||||
{
|
||||
"tag": "United States of America"
|
||||
}
|
||||
],
|
||||
"Role": [
|
||||
{
|
||||
"tag": "Paul Rudd"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,62 +0,0 @@
|
||||
import GetFileHash from "./get_file_hash/get_file_hash.mdx";
|
||||
import GetRecentlyAdded from "./get_recently_added/get_recently_added.mdx";
|
||||
import GetLibraries from "./get_libraries/get_libraries.mdx";
|
||||
import GetLibrary from "./get_library/get_library.mdx";
|
||||
import DeleteLibrary from "./delete_library/delete_library.mdx";
|
||||
import GetLibraryItems from "./get_library_items/get_library_items.mdx";
|
||||
import RefreshLibrary from "./refresh_library/refresh_library.mdx";
|
||||
import SearchLibrary from "./search_library/search_library.mdx";
|
||||
import GetMetadata from "./get_metadata/get_metadata.mdx";
|
||||
import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx";
|
||||
import GetOnDeck from "./get_on_deck/get_on_deck.mdx";
|
||||
|
||||
## Library
|
||||
API Calls interacting with Plex Media Server Libraries
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get File Hash](/python/library/get_file_hash) - Get Hash Value
|
||||
* [Get Recently Added](/python/library/get_recently_added) - Get Recently Added
|
||||
* [Get Libraries](/python/library/get_libraries) - Get All Libraries
|
||||
* [Get Library](/python/library/get_library) - Get Library Details
|
||||
* [Delete Library](/python/library/delete_library) - Delete Library Section
|
||||
* [Get Library Items](/python/library/get_library_items) - Get Library Items
|
||||
* [Refresh Library](/python/library/refresh_library) - Refresh Library
|
||||
* [Search Library](/python/library/search_library) - Search Library
|
||||
* [Get Metadata](/python/library/get_metadata) - Get Items Metadata
|
||||
* [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children
|
||||
* [Get On Deck](/python/library/get_on_deck) - Get On Deck
|
||||
|
||||
---
|
||||
<GetFileHash />
|
||||
|
||||
---
|
||||
<GetRecentlyAdded />
|
||||
|
||||
---
|
||||
<GetLibraries />
|
||||
|
||||
---
|
||||
<GetLibrary />
|
||||
|
||||
---
|
||||
<DeleteLibrary />
|
||||
|
||||
---
|
||||
<GetLibraryItems />
|
||||
|
||||
---
|
||||
<RefreshLibrary />
|
||||
|
||||
---
|
||||
<SearchLibrary />
|
||||
|
||||
---
|
||||
<GetMetadata />
|
||||
|
||||
---
|
||||
<GetMetadataChildren />
|
||||
|
||||
---
|
||||
<GetOnDeck />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Refresh Library
|
||||
|
||||
This endpoint Refreshes the library.
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to refresh
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import RefreshLibraryResponse from "/content/types/models/operations/refresh_library_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.RefreshLibraryResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<RefreshLibraryResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python RefreshLibrary.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.refresh_library(section_id=4776.65)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,20 +0,0 @@
|
||||
## Search Library
|
||||
|
||||
Search for content within a specific section of the library.
|
||||
|
||||
### Types
|
||||
Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls:
|
||||
|
||||
- **Type Object Attributes**:
|
||||
- `type`: Metadata type (if standard Plex type).
|
||||
- `title`: Title for this content type (e.g., "Movies").
|
||||
|
||||
- **Filter Objects**:
|
||||
- Subset of the media query language.
|
||||
- Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`.
|
||||
|
||||
- **Sort Objects**:
|
||||
- Description of sort fields.
|
||||
- Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`.
|
||||
|
||||
> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Type from "/content/types/models/operations/type/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `section_id` *{`int`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` *{`operations.Type`}*
|
||||
Plex content type to search for
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Type />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import SearchLibraryResponse from "/content/types/models/operations/search_library_response/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.SearchLibraryResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<SearchLibraryResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python SearchLibrary.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.library.search_library(section_id=791725, type=operations.Type.FOUR)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 2,
|
||||
"allowSync": false,
|
||||
"art": "/:/resources/show-fanart.jpg",
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1698860922,
|
||||
"nocache": true,
|
||||
"thumb": "/:/resources/show.png",
|
||||
"title1": "TV Shows",
|
||||
"title2": "Search for ''",
|
||||
"viewGroup": "season",
|
||||
"viewMode": 65593,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user