mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-06 12:37:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0
This commit is contained in:
speakeasybot
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 7fc33f51-d778-40ef-b094-90972c025d39
|
||||
management:
|
||||
docChecksum: 7aba498c024534142941d65a7c2e649c
|
||||
docChecksum: 95d4ac4070b7f9db42126fc81b258e02
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: internal
|
||||
generationVersion: 2.237.3
|
||||
releaseVersion: 0.2.0
|
||||
configChecksum: 7adcc65dd0834e56b5a7642677ff9159
|
||||
generationVersion: 2.239.0
|
||||
releaseVersion: 0.2.1
|
||||
configChecksum: 5421929b3e489a66ede916e408575cf8
|
||||
published: true
|
||||
features:
|
||||
docs:
|
||||
@@ -122,6 +122,11 @@ generatedFiles:
|
||||
- content/pages/01-reference/go/resources/library/refresh_library/_response.mdx
|
||||
- content/pages/01-reference/go/resources/library/refresh_library/_usage.mdx
|
||||
- content/pages/01-reference/go/resources/library/refresh_library/refresh_library.mdx
|
||||
- content/pages/01-reference/go/resources/library/search_library/_header.mdx
|
||||
- content/pages/01-reference/go/resources/library/search_library/_parameters.mdx
|
||||
- content/pages/01-reference/go/resources/library/search_library/_response.mdx
|
||||
- content/pages/01-reference/go/resources/library/search_library/_usage.mdx
|
||||
- content/pages/01-reference/go/resources/library/search_library/search_library.mdx
|
||||
- content/pages/01-reference/go/resources/log/enable_paper_trail/_header.mdx
|
||||
- content/pages/01-reference/go/resources/log/enable_paper_trail/_parameters.mdx
|
||||
- content/pages/01-reference/go/resources/log/enable_paper_trail/_response.mdx
|
||||
@@ -422,6 +427,11 @@ generatedFiles:
|
||||
- content/pages/01-reference/python/resources/library/refresh_library/_response.mdx
|
||||
- content/pages/01-reference/python/resources/library/refresh_library/_usage.mdx
|
||||
- content/pages/01-reference/python/resources/library/refresh_library/refresh_library.mdx
|
||||
- content/pages/01-reference/python/resources/library/search_library/_header.mdx
|
||||
- content/pages/01-reference/python/resources/library/search_library/_parameters.mdx
|
||||
- content/pages/01-reference/python/resources/library/search_library/_response.mdx
|
||||
- content/pages/01-reference/python/resources/library/search_library/_usage.mdx
|
||||
- content/pages/01-reference/python/resources/library/search_library/search_library.mdx
|
||||
- content/pages/01-reference/python/resources/log/enable_paper_trail/_header.mdx
|
||||
- content/pages/01-reference/python/resources/log/enable_paper_trail/_parameters.mdx
|
||||
- content/pages/01-reference/python/resources/log/enable_paper_trail/_response.mdx
|
||||
@@ -722,6 +732,11 @@ generatedFiles:
|
||||
- content/pages/01-reference/typescript/resources/library/refresh_library/_response.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/refresh_library/_usage.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/refresh_library/refresh_library.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/search_library/_header.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/search_library/_response.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/search_library/_usage.mdx
|
||||
- content/pages/01-reference/typescript/resources/library/search_library/search_library.mdx
|
||||
- content/pages/01-reference/typescript/resources/log/enable_paper_trail/_header.mdx
|
||||
- content/pages/01-reference/typescript/resources/log/enable_paper_trail/_parameters.mdx
|
||||
- content/pages/01-reference/typescript/resources/log/enable_paper_trail/_response.mdx
|
||||
@@ -1702,6 +1717,9 @@ generatedFiles:
|
||||
- content/types/models/operations/get_transcode_sessions_response_body/go.mdx
|
||||
- content/types/models/operations/get_transcode_sessions_response_body/python.mdx
|
||||
- content/types/models/operations/get_transcode_sessions_response_body/typescript.mdx
|
||||
- content/types/models/operations/get_transient_token_query_param_type/go.mdx
|
||||
- content/types/models/operations/get_transient_token_query_param_type/python.mdx
|
||||
- content/types/models/operations/get_transient_token_query_param_type/typescript.mdx
|
||||
- content/types/models/operations/get_transient_token_request/go.mdx
|
||||
- content/types/models/operations/get_transient_token_request/python.mdx
|
||||
- content/types/models/operations/get_transient_token_request/typescript.mdx
|
||||
@@ -1834,6 +1852,21 @@ generatedFiles:
|
||||
- content/types/models/operations/scope/go.mdx
|
||||
- content/types/models/operations/scope/python.mdx
|
||||
- content/types/models/operations/scope/typescript.mdx
|
||||
- content/types/models/operations/search_library_media_container/go.mdx
|
||||
- content/types/models/operations/search_library_media_container/python.mdx
|
||||
- content/types/models/operations/search_library_media_container/typescript.mdx
|
||||
- content/types/models/operations/search_library_metadata/go.mdx
|
||||
- content/types/models/operations/search_library_metadata/python.mdx
|
||||
- content/types/models/operations/search_library_metadata/typescript.mdx
|
||||
- content/types/models/operations/search_library_request/go.mdx
|
||||
- content/types/models/operations/search_library_request/python.mdx
|
||||
- content/types/models/operations/search_library_request/typescript.mdx
|
||||
- content/types/models/operations/search_library_response/go.mdx
|
||||
- content/types/models/operations/search_library_response/python.mdx
|
||||
- content/types/models/operations/search_library_response/typescript.mdx
|
||||
- content/types/models/operations/search_library_response_body/go.mdx
|
||||
- content/types/models/operations/search_library_response_body/python.mdx
|
||||
- content/types/models/operations/search_library_response_body/typescript.mdx
|
||||
- content/types/models/operations/server/go.mdx
|
||||
- content/types/models/operations/server/python.mdx
|
||||
- content/types/models/operations/server/typescript.mdx
|
||||
@@ -2232,6 +2265,12 @@ generatedFiles:
|
||||
- content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx
|
||||
- content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx
|
||||
- content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/search_library.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/_response.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/_usage.mdx
|
||||
- content/pages/01-reference/curl/resources/library/search_library/_header.mdx
|
||||
- content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx
|
||||
- content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx
|
||||
- content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx
|
||||
@@ -2594,6 +2633,12 @@ generatedFiles:
|
||||
- content/types/operations/refresh_library_errors/curl.mdx
|
||||
- content/types/operations/refresh_library_response_body/curl.mdx
|
||||
- content/types/operations/refresh_library_response/curl.mdx
|
||||
- content/types/operations/type/curl.mdx
|
||||
- content/types/operations/search_library_request/curl.mdx
|
||||
- content/types/operations/search_library_metadata/curl.mdx
|
||||
- content/types/operations/search_library_media_container/curl.mdx
|
||||
- content/types/operations/search_library_response_body/curl.mdx
|
||||
- content/types/operations/search_library_response/curl.mdx
|
||||
- content/types/operations/get_metadata_request/curl.mdx
|
||||
- content/types/operations/get_metadata_errors/curl.mdx
|
||||
- content/types/operations/get_metadata_library_response_body/curl.mdx
|
||||
@@ -2642,7 +2687,7 @@ generatedFiles:
|
||||
- content/types/operations/enable_paper_trail_errors/curl.mdx
|
||||
- content/types/operations/enable_paper_trail_response_body/curl.mdx
|
||||
- content/types/operations/enable_paper_trail_response/curl.mdx
|
||||
- content/types/operations/type/curl.mdx
|
||||
- content/types/operations/query_param_type/curl.mdx
|
||||
- content/types/operations/smart/curl.mdx
|
||||
- content/types/operations/create_playlist_request/curl.mdx
|
||||
- content/types/operations/create_playlist_errors/curl.mdx
|
||||
@@ -2705,7 +2750,7 @@ generatedFiles:
|
||||
- content/types/operations/upload_playlist_errors/curl.mdx
|
||||
- content/types/operations/upload_playlist_response_body/curl.mdx
|
||||
- content/types/operations/upload_playlist_response/curl.mdx
|
||||
- content/types/operations/query_param_type/curl.mdx
|
||||
- content/types/operations/get_transient_token_query_param_type/curl.mdx
|
||||
- content/types/operations/scope/curl.mdx
|
||||
- content/types/operations/get_transient_token_request/curl.mdx
|
||||
- content/types/operations/get_transient_token_errors/curl.mdx
|
||||
@@ -3018,6 +3063,12 @@ generatedFiles:
|
||||
- src/.gen/pages/01-reference/python/resources/library/refresh_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/refresh_library/refresh_library.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/refresh_library/refresh_library_content.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/_header.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/_parameters.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/_response.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/search_library.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/search_library/search_library_content.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/library.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/library/library_content.mdx
|
||||
- src/.gen/pages/01-reference/python/resources/log/enable_paper_trail/_header.mdx
|
||||
@@ -3289,9 +3340,7 @@ generatedFiles:
|
||||
- src/pages/python/hubs/get_library_hubs/_meta.json
|
||||
- src/pages/python/hubs/_meta.json
|
||||
- src/pages/python/library/delete_library/_meta.json
|
||||
- src/pages/python/library/get_common_library_items/_meta.json
|
||||
- src/pages/python/library/get_file_hash/_meta.json
|
||||
- src/pages/python/library/get_latest_library_items/_meta.json
|
||||
- src/pages/python/library/get_libraries/_meta.json
|
||||
- src/pages/python/library/get_library/_meta.json
|
||||
- src/pages/python/library/get_library_items/_meta.json
|
||||
@@ -3300,6 +3349,7 @@ generatedFiles:
|
||||
- src/pages/python/library/get_on_deck/_meta.json
|
||||
- src/pages/python/library/get_recently_added/_meta.json
|
||||
- src/pages/python/library/refresh_library/_meta.json
|
||||
- src/pages/python/library/search_library/_meta.json
|
||||
- src/pages/python/library/_meta.json
|
||||
- src/pages/python/log/enable_paper_trail/_meta.json
|
||||
- src/pages/python/log/log_line/_meta.json
|
||||
@@ -3481,6 +3531,12 @@ generatedFiles:
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/refresh_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/refresh_library/refresh_library.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/refresh_library/refresh_library_content.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/_header.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/_response.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library_content.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/library.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx
|
||||
- src/.gen/pages/01-reference/typescript/resources/log/enable_paper_trail/_header.mdx
|
||||
@@ -3752,9 +3808,7 @@ generatedFiles:
|
||||
- src/pages/typescript/hubs/get_library_hubs/_meta.json
|
||||
- src/pages/typescript/hubs/_meta.json
|
||||
- src/pages/typescript/library/delete_library/_meta.json
|
||||
- src/pages/typescript/library/get_common_library_items/_meta.json
|
||||
- src/pages/typescript/library/get_file_hash/_meta.json
|
||||
- src/pages/typescript/library/get_latest_library_items/_meta.json
|
||||
- src/pages/typescript/library/get_libraries/_meta.json
|
||||
- src/pages/typescript/library/get_library/_meta.json
|
||||
- src/pages/typescript/library/get_library_items/_meta.json
|
||||
@@ -3763,6 +3817,7 @@ generatedFiles:
|
||||
- src/pages/typescript/library/get_on_deck/_meta.json
|
||||
- src/pages/typescript/library/get_recently_added/_meta.json
|
||||
- src/pages/typescript/library/refresh_library/_meta.json
|
||||
- src/pages/typescript/library/search_library/_meta.json
|
||||
- src/pages/typescript/library/_meta.json
|
||||
- src/pages/typescript/log/enable_paper_trail/_meta.json
|
||||
- src/pages/typescript/log/log_line/_meta.json
|
||||
@@ -3944,6 +3999,12 @@ generatedFiles:
|
||||
- src/.gen/pages/01-reference/go/resources/library/refresh_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/refresh_library/refresh_library.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/refresh_library/refresh_library_content.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/_header.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/_parameters.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/_response.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/search_library.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/search_library/search_library_content.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/library.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/library/library_content.mdx
|
||||
- src/.gen/pages/01-reference/go/resources/log/enable_paper_trail/_header.mdx
|
||||
@@ -4215,9 +4276,7 @@ generatedFiles:
|
||||
- src/pages/go/hubs/get_library_hubs/_meta.json
|
||||
- src/pages/go/hubs/_meta.json
|
||||
- src/pages/go/library/delete_library/_meta.json
|
||||
- src/pages/go/library/get_common_library_items/_meta.json
|
||||
- src/pages/go/library/get_file_hash/_meta.json
|
||||
- src/pages/go/library/get_latest_library_items/_meta.json
|
||||
- src/pages/go/library/get_libraries/_meta.json
|
||||
- src/pages/go/library/get_library/_meta.json
|
||||
- src/pages/go/library/get_library_items/_meta.json
|
||||
@@ -4226,6 +4285,7 @@ generatedFiles:
|
||||
- src/pages/go/library/get_on_deck/_meta.json
|
||||
- src/pages/go/library/get_recently_added/_meta.json
|
||||
- src/pages/go/library/refresh_library/_meta.json
|
||||
- src/pages/go/library/search_library/_meta.json
|
||||
- src/pages/go/library/_meta.json
|
||||
- src/pages/go/log/enable_paper_trail/_meta.json
|
||||
- src/pages/go/log/log_line/_meta.json
|
||||
@@ -4417,6 +4477,13 @@ generatedFiles:
|
||||
- src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/refresh_library/refresh_library.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/refresh_library/refresh_library_content.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/_authentication.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/_header.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/_parameters.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/search_library.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/search_library/search_library_content.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/library.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/library/library_content.mdx
|
||||
- src/.gen/pages/01-reference/curl/resources/log/enable_paper_trail/_authentication.mdx
|
||||
@@ -4714,9 +4781,7 @@ generatedFiles:
|
||||
- src/pages/curl/hubs/get_library_hubs/_meta.json
|
||||
- src/pages/curl/hubs/_meta.json
|
||||
- src/pages/curl/library/delete_library/_meta.json
|
||||
- src/pages/curl/library/get_common_library_items/_meta.json
|
||||
- src/pages/curl/library/get_file_hash/_meta.json
|
||||
- src/pages/curl/library/get_latest_library_items/_meta.json
|
||||
- src/pages/curl/library/get_libraries/_meta.json
|
||||
- src/pages/curl/library/get_library/_meta.json
|
||||
- src/pages/curl/library/get_library_items/_meta.json
|
||||
@@ -4725,6 +4790,7 @@ generatedFiles:
|
||||
- src/pages/curl/library/get_on_deck/_meta.json
|
||||
- src/pages/curl/library/get_recently_added/_meta.json
|
||||
- src/pages/curl/library/refresh_library/_meta.json
|
||||
- src/pages/curl/library/search_library/_meta.json
|
||||
- src/pages/curl/library/_meta.json
|
||||
- src/pages/curl/log/enable_paper_trail/_meta.json
|
||||
- src/pages/curl/log/log_line/_meta.json
|
||||
|
||||
@@ -35,3 +35,9 @@ Based on:
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||
|
||||
## 2024-01-24 00:31:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.151.0 (2.239.0) https://github.com/speakeasy-api/speakeasy
|
||||
@@ -24,5 +24,4 @@ Fetches details from a specific section of the library identified by a section k
|
||||
- `resolution`: Items categorized by resolution.
|
||||
- `firstCharacter`: Items categorized by the first letter.
|
||||
- `folder`: Items categorized by folder.
|
||||
- `search?type=1`: Search functionality within the section.
|
||||
|
||||
|
||||
@@ -24,6 +24,7 @@ curl http://10.10.10.47:32400/library/sections/528895/{{tag}} \
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/metadata/5680.45 \
|
||||
curl http://10.10.10.47:32400/library/metadata/3927.85 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/metadata/3927.85/children \
|
||||
curl http://10.10.10.47:32400/library/metadata/9255.97/children \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -5,6 +5,7 @@ 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";
|
||||
@@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [Delete Library](/curl/library/delete_library) - Delete Library Section
|
||||
* [Get Library Items](/curl/library/get_library_items) - Get Library Items
|
||||
* [Refresh Library](/curl/library/refresh_library) - Refresh Library
|
||||
* [Search Library](/curl/library/search_library) - Search Library
|
||||
* [Get Metadata](/curl/library/get_metadata) - Get Items Metadata
|
||||
* [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children
|
||||
* [Get On Deck](/curl/library/get_on_deck) - Get On Deck
|
||||
@@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
---
|
||||
<RefreshLibrary />
|
||||
|
||||
---
|
||||
<SearchLibrary />
|
||||
|
||||
---
|
||||
<GetMetadata />
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### API key _— in HTTP header_
|
||||
|
||||
Set your API key in a `X-Plex-Token` HTTP header.
|
||||
|
||||
Example: `<no value>`
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
import OperationInfo from '/src/components/OperationInfo';
|
||||
|
||||
## Search Library
|
||||
|
||||
<OperationInfo method='get' path='/library/sections/{sectionId}/search' />
|
||||
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Type from "/content/types/operations/type/curl.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `sectionId` _integer_
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` _enumeration_
|
||||
Plex content type to search for
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Type />
|
||||
</Collapsible>
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import SearchLibraryMediaContainer from "/content/types/operations/search_library_media_container/curl.mdx"
|
||||
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
|
||||
import StatusCode from '@/src/components/StatusCode';
|
||||
|
||||
<TabbedSection tabLabel='Status Code'>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"200"} />}>
|
||||
*JSON object*
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
##### `MediaContainer` _object (optional)_
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<SearchLibraryMediaContainer/>
|
||||
</Collapsible>
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
</TabbedSection>
|
||||
@@ -0,0 +1,29 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/sections/568045/search \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -0,0 +1,12 @@
|
||||
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,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/3682.41/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \
|
||||
curl http://10.10.10.47:32400/playlists/8326.2/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/202.18/items \
|
||||
curl http://10.10.10.47:32400/playlists/3682.41/items \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Type from "/content/types/operations/type/curl.mdx"
|
||||
import QueryParamType from "/content/types/operations/query_param_type/curl.mdx"
|
||||
import Smart from "/content/types/operations/smart/curl.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
@@ -12,7 +12,7 @@ name of the playlist
|
||||
type of playlist to create
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Type />
|
||||
<QueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists?playQueueID=9255.97&title=string&uri=string \
|
||||
curl http://10.10.10.47:32400/playlists?playQueueID=8360.79&title=string&uri=string \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/710.36 \
|
||||
curl http://10.10.10.47:32400/playlists/3373.96 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/8360.79 \
|
||||
curl http://10.10.10.47:32400/playlists/710.36 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/871.29/items?type=6481.72 \
|
||||
curl http://10.10.10.47:32400/playlists/6481.72/items?type=202.18 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/3373.96?summary=string&title=string \
|
||||
curl http://10.10.10.47:32400/playlists/871.29?summary=string&title=string \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import QueryParamType from "/content/types/operations/query_param_type/curl.mdx"
|
||||
import GetTransientTokenQueryParamType from "/content/types/operations/get_transient_token_query_param_type/curl.mdx"
|
||||
import Scope from "/content/types/operations/scope/curl.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
@@ -8,7 +8,7 @@ import Labels from "/src/lib/labels";
|
||||
`delegation` \- This is the only supported `type` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<QueryParamType />
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/:/timeline?context=string&duration=7206.33&hasMDE=6788.8&key=string&playBackTime=5820.2&playQueueItemID=6399.21&ratingKey=7805.29&row=1433.53&time=1182.74 \
|
||||
curl http://10.10.10.47:32400/:/timeline?context=string&duration=6399.21&hasMDE=1182.74&key=string&playBackTime=1433.53&playQueueItemID=5820.2&ratingKey=6788.8&row=5373.73&time=7206.33 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4614.79&audioBoost=7991.59&autoAdjustQuality=5204.78&directPlay=8700.88&directStream=9786.19&fastSeek=8700.13&hasMDE=9571.56&location=string&mediaBufferSize=8009.11&mediaIndex=7781.57&partIndex=1403.5&path=string&protocol=string&session=string&subtites=string&subtitleSize=4736.08 \
|
||||
curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=5204.78&audioBoost=8009.11&autoAdjustQuality=7805.29&directPlay=9786.19&directStream=4736.08&fastSeek=8700.88&hasMDE=7781.57&location=string&mediaBufferSize=4614.79&mediaIndex=1403.5&partIndex=8700.13&path=string&protocol=string&session=string&subtites=string&subtitleSize=7991.59 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k
|
||||
- `resolution`: Items categorized by resolution.
|
||||
- `firstCharacter`: Items categorized by the first letter.
|
||||
- `folder`: Items categorized by folder.
|
||||
- `search?type=1`: Search functionality within the section.
|
||||
|
||||
@@ -51,6 +51,7 @@ func main() {
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,7 +16,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var ratingKey float64 = 7917.25
|
||||
var ratingKey float64 = 5288.95
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.GetMetadata(ctx, ratingKey)
|
||||
|
||||
@@ -16,7 +16,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var ratingKey float64 = 8121.69
|
||||
var ratingKey float64 = 4799.77
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.GetMetadataChildren(ctx, ratingKey)
|
||||
|
||||
@@ -5,6 +5,7 @@ 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";
|
||||
@@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [Delete Library](/go/library/delete_library) - Delete Library Section
|
||||
* [Get Library Items](/go/library/get_library_items) - Get Library Items
|
||||
* [Refresh Library](/go/library/refresh_library) - Refresh Library
|
||||
* [Search Library](/go/library/search_library) - Search Library
|
||||
* [Get Metadata](/go/library/get_metadata) - Get Items Metadata
|
||||
* [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children
|
||||
* [Get On Deck](/go/library/get_on_deck) - Get On Deck
|
||||
@@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
---
|
||||
<RefreshLibrary />
|
||||
|
||||
---
|
||||
<SearchLibrary />
|
||||
|
||||
---
|
||||
<GetMetadata />
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
## 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.
|
||||
@@ -0,0 +1,20 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import Type from "/content/types/models/operations/type/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
---
|
||||
##### `sectionID` *{`int64`}*
|
||||
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>
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import SearchLibraryResponse from "/content/types/models/operations/search_library_response/go.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>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
|
||||
<CH.Code>
|
||||
```go SearchLibrary.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var sectionID int64 = 791725
|
||||
|
||||
var type_ operations.Type = operations.TypeFour
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Library.SearchLibrary(ctx, sectionID, type_)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -16,7 +16,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 1403.5
|
||||
var playlistID float64 = 8700.88
|
||||
|
||||
var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1"
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 7781.57
|
||||
var playlistID float64 = 8700.13
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Playlists.ClearPlaylistContents(ctx, playlistID)
|
||||
|
||||
@@ -19,9 +19,9 @@ func main() {
|
||||
ctx := context.Background()
|
||||
res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{
|
||||
Title: "string",
|
||||
Type: operations.TypeVideo,
|
||||
Type: operations.QueryParamTypeVideo,
|
||||
Smart: operations.SmartOne,
|
||||
URI: "http://velvety-spiderling.com",
|
||||
URI: "https://bite-sized-favorite.com",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
|
||||
@@ -17,7 +17,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 202.18
|
||||
var playlistID float64 = 8326.2
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Playlists.DeletePlaylist(ctx, playlistID)
|
||||
|
||||
@@ -16,7 +16,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 6481.72
|
||||
var playlistID float64 = 3682.41
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Playlists.GetPlaylist(ctx, playlistID)
|
||||
|
||||
@@ -16,9 +16,9 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 8326.2
|
||||
var playlistID float64 = 7781.57
|
||||
|
||||
var type_ float64 = 9571.56
|
||||
var type_ float64 = 1403.5
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Playlists.GetPlaylistContents(ctx, playlistID, type_)
|
||||
|
||||
@@ -17,7 +17,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var playlistID float64 = 3682.41
|
||||
var playlistID float64 = 9571.56
|
||||
|
||||
var title *string = "string"
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var source string = "provider://provider-identifier"
|
||||
var source string = "server://client-identifier"
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Security.GetSourceConnectionInformation(ctx, source)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import QueryParamType from "/content/types/models/operations/query_param_type/go.mdx"
|
||||
import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/go.mdx"
|
||||
import Scope from "/content/types/models/operations/scope/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
@@ -8,11 +8,11 @@ import Labels from "/src/lib/labels";
|
||||
The context to use for the request.
|
||||
|
||||
---
|
||||
##### `type_` *{`operations.QueryParamType`}*
|
||||
##### `type_` *{`operations.GetTransientTokenQueryParamType`}*
|
||||
`delegation` \- This is the only supported `type` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<QueryParamType />
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -18,7 +18,7 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var type_ operations.QueryParamType = operations.QueryParamTypeDelegation
|
||||
var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation
|
||||
|
||||
var scope operations.Scope = operations.ScopeAll
|
||||
|
||||
|
||||
@@ -18,9 +18,9 @@ func main() {
|
||||
)
|
||||
|
||||
|
||||
var tonight *operations.Tonight = operations.TonightZero
|
||||
var tonight *operations.Tonight = operations.TonightOne
|
||||
|
||||
var skip *operations.Skip = operations.SkipOne
|
||||
var skip *operations.Skip = operations.SkipZero
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Updater.ApplyUpdates(ctx, tonight, skip)
|
||||
|
||||
@@ -19,16 +19,16 @@ func main() {
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Video.GetTimeline(ctx, operations.GetTimelineRequest{
|
||||
RatingKey: 6788.8,
|
||||
RatingKey: 7206.33,
|
||||
Key: "<key>",
|
||||
State: operations.StatePlaying,
|
||||
HasMDE: 7206.33,
|
||||
Time: 6399.21,
|
||||
Duration: 5820.2,
|
||||
State: operations.StatePaused,
|
||||
HasMDE: 5820.2,
|
||||
Time: 1433.53,
|
||||
Duration: 5373.73,
|
||||
Context: "string",
|
||||
PlayQueueItemID: 1433.53,
|
||||
PlayBackTime: 5373.73,
|
||||
Row: 9446.69,
|
||||
PlayQueueItemID: 9446.69,
|
||||
PlayBackTime: 7586.16,
|
||||
Row: 5218.48,
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
|
||||
@@ -19,10 +19,10 @@ func main() {
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Video.StartUniversalTranscode(ctx, operations.StartUniversalTranscodeRequest{
|
||||
HasMDE: 8009.11,
|
||||
Path: "/private",
|
||||
MediaIndex: 5204.78,
|
||||
PartIndex: 7805.29,
|
||||
HasMDE: 5204.78,
|
||||
Path: "/usr/libexec",
|
||||
MediaIndex: 6788.8,
|
||||
PartIndex: 1182.74,
|
||||
Protocol: "string",
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
@@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k
|
||||
- `resolution`: Items categorized by resolution.
|
||||
- `firstCharacter`: Items categorized by the first letter.
|
||||
- `folder`: Items categorized by folder.
|
||||
- `search?type=1`: Search functionality within the section.
|
||||
|
||||
@@ -34,6 +34,7 @@ if res.object is not None:
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_metadata(rating_key=7917.25)
|
||||
res = s.library.get_metadata(rating_key=5288.95)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_metadata_children(rating_key=8121.69)
|
||||
res = s.library.get_metadata_children(rating_key=4799.77)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -5,6 +5,7 @@ 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";
|
||||
@@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [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
|
||||
@@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
---
|
||||
<RefreshLibrary />
|
||||
|
||||
---
|
||||
<SearchLibrary />
|
||||
|
||||
---
|
||||
<GetMetadata />
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
## 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.
|
||||
@@ -0,0 +1,16 @@
|
||||
{/* 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>
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* 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>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)
|
||||
res = s.playlists.add_playlist_contents(playlist_id=8700.88, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.clear_playlist_contents(playlist_id=7781.57)
|
||||
res = s.playlists.clear_playlist_contents(playlist_id=8700.13)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -10,9 +10,9 @@ s = plex_api.PlexAPI(
|
||||
|
||||
req = operations.CreatePlaylistRequest(
|
||||
title='string',
|
||||
type=operations.Type.VIDEO,
|
||||
type=operations.QueryParamType.VIDEO,
|
||||
smart=operations.Smart.ONE,
|
||||
uri='http://velvety-spiderling.com',
|
||||
uri='https://bite-sized-favorite.com',
|
||||
)
|
||||
|
||||
res = s.playlists.create_playlist(req)
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.delete_playlist(playlist_id=202.18)
|
||||
res = s.playlists.delete_playlist(playlist_id=8326.2)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.get_playlist(playlist_id=6481.72)
|
||||
res = s.playlists.get_playlist(playlist_id=3682.41)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56)
|
||||
res = s.playlists.get_playlist_contents(playlist_id=7781.57, type=1403.5)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string')
|
||||
res = s.playlists.update_playlist(playlist_id=9571.56, title='string', summary='string')
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.security.get_source_connection_information(source='provider://provider-identifier')
|
||||
res = s.security.get_source_connection_information(source='server://client-identifier')
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import QueryParamType from "/content/types/models/operations/query_param_type/python.mdx"
|
||||
import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/python.mdx"
|
||||
import Scope from "/content/types/models/operations/scope/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `type` *{`operations.QueryParamType`}*
|
||||
##### `type` *{`operations.GetTransientTokenQueryParamType`}*
|
||||
`delegation` \- This is the only supported `type` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<QueryParamType />
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.security.get_transient_token(type=operations.QueryParamType.DELEGATION, scope=operations.Scope.ALL)
|
||||
res = s.security.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.updater.apply_updates(tonight=operations.Tonight.ZERO, skip=operations.Skip.ONE)
|
||||
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ZERO)
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
|
||||
@@ -9,16 +9,16 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
req = operations.GetTimelineRequest(
|
||||
rating_key=6788.8,
|
||||
rating_key=7206.33,
|
||||
key='<key>',
|
||||
state=operations.State.PLAYING,
|
||||
has_mde=7206.33,
|
||||
time=6399.21,
|
||||
duration=5820.2,
|
||||
state=operations.State.PAUSED,
|
||||
has_mde=5820.2,
|
||||
time=1433.53,
|
||||
duration=5373.73,
|
||||
context='string',
|
||||
play_queue_item_id=1433.53,
|
||||
play_back_time=5373.73,
|
||||
row=9446.69,
|
||||
play_queue_item_id=9446.69,
|
||||
play_back_time=7586.16,
|
||||
row=5218.48,
|
||||
)
|
||||
|
||||
res = s.video.get_timeline(req)
|
||||
|
||||
@@ -9,10 +9,10 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
req = operations.StartUniversalTranscodeRequest(
|
||||
has_mde=8009.11,
|
||||
path='/private',
|
||||
media_index=5204.78,
|
||||
part_index=7805.29,
|
||||
has_mde=5204.78,
|
||||
path='/usr/libexec',
|
||||
media_index=6788.8,
|
||||
part_index=1182.74,
|
||||
protocol='string',
|
||||
)
|
||||
|
||||
|
||||
@@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k
|
||||
- `resolution`: Items categorized by resolution.
|
||||
- `firstCharacter`: Items categorized by the first letter.
|
||||
- `folder`: Items categorized by folder.
|
||||
- `search?type=1`: Search functionality within the section.
|
||||
|
||||
@@ -39,6 +39,7 @@ run();
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const ratingKey = 7917.25;
|
||||
const ratingKey = 5288.95;
|
||||
|
||||
const result = await sdk.library.getMetadata(ratingKey);
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const ratingKey = 8121.69;
|
||||
const ratingKey = 4799.77;
|
||||
|
||||
const result = await sdk.library.getMetadataChildren(ratingKey);
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ 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";
|
||||
@@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [Delete Library](/typescript/library/delete_library) - Delete Library Section
|
||||
* [Get Library Items](/typescript/library/get_library_items) - Get Library Items
|
||||
* [Refresh Library](/typescript/library/refresh_library) - Refresh Library
|
||||
* [Search Library](/typescript/library/search_library) - Search Library
|
||||
* [Get Metadata](/typescript/library/get_metadata) - Get Items Metadata
|
||||
* [Get Metadata Children](/typescript/library/get_metadata_children) - Get Items Children
|
||||
* [Get On Deck](/typescript/library/get_on_deck) - Get On Deck
|
||||
@@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
---
|
||||
<RefreshLibrary />
|
||||
|
||||
---
|
||||
<SearchLibrary />
|
||||
|
||||
---
|
||||
<GetMetadata />
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
## 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.
|
||||
@@ -0,0 +1,24 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import TypeT from "/content/types/models/operations/type_t/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `sectionId`: *{`number`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type`: *{`operations.TypeT`}*
|
||||
Plex content type to search for
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<TypeT />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
##### `options?`: *{`RequestOptions`}*
|
||||
Options for making HTTP requests.
|
||||
|
||||
---
|
||||
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)
|
||||
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import SearchLibraryResponse from "/content/types/models/operations/search_library_response/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`Promise<operations.SearchLibraryResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<SearchLibraryResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript SearchLibrary.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { TypeT } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const sectionId = 791725;
|
||||
const type = TypeT.Four;
|
||||
|
||||
const result = await sdk.library.searchLibrary(sectionId, type);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
---
|
||||
|
||||
```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>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Library*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 1403.5;
|
||||
const playlistID = 8700.88;
|
||||
const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1";
|
||||
const playQueueID = 123;
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 7781.57;
|
||||
const playlistID = 8700.13;
|
||||
|
||||
const result = await sdk.playlists.clearPlaylistContents(playlistID);
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<CH.Code>
|
||||
```typescript CreatePlaylist.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Smart, TypeT } from "@lukehagar/plexjs/models/operations";
|
||||
import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
@@ -11,9 +11,9 @@ async function run() {
|
||||
|
||||
const result = await sdk.playlists.createPlaylist({
|
||||
title: "string",
|
||||
type: TypeT.Video,
|
||||
type: QueryParamType.Video,
|
||||
smart: Smart.One,
|
||||
uri: "http://velvety-spiderling.com",
|
||||
uri: "https://bite-sized-favorite.com",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 202.18;
|
||||
const playlistID = 8326.2;
|
||||
|
||||
const result = await sdk.playlists.deletePlaylist(playlistID);
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 6481.72;
|
||||
const playlistID = 3682.41;
|
||||
|
||||
const result = await sdk.playlists.getPlaylist(playlistID);
|
||||
|
||||
|
||||
@@ -8,8 +8,8 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 8326.2;
|
||||
const type = 9571.56;
|
||||
const playlistID = 7781.57;
|
||||
const type = 1403.5;
|
||||
|
||||
const result = await sdk.playlists.getPlaylistContents(playlistID, type);
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const playlistID = 3682.41;
|
||||
const playlistID = 9571.56;
|
||||
const title = "string";
|
||||
const summary = "string";
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const source = "provider://provider-identifier";
|
||||
const source = "server://client-identifier";
|
||||
|
||||
const result = await sdk.security.getSourceConnectionInformation(source);
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import QueryParamType from "/content/types/models/operations/query_param_type/typescript.mdx"
|
||||
import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx"
|
||||
import Scope from "/content/types/models/operations/scope/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `type`: *{`operations.QueryParamType`}*
|
||||
##### `type`: *{`operations.GetTransientTokenQueryParamType`}*
|
||||
`delegation` \- This is the only supported `type` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<QueryParamType />
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
<CH.Code>
|
||||
```typescript GetTransientToken.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const type = QueryParamType.Delegation;
|
||||
const type = GetTransientTokenQueryParamType.Delegation;
|
||||
const scope = Scope.All;
|
||||
|
||||
const result = await sdk.security.getTransientToken(type, scope);
|
||||
|
||||
@@ -9,8 +9,8 @@ async function run() {
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const tonight = Tonight.Zero;
|
||||
const skip = Skip.One;
|
||||
const tonight = Tonight.One;
|
||||
const skip = Skip.Zero;
|
||||
|
||||
const result = await sdk.updater.applyUpdates(tonight, skip);
|
||||
|
||||
|
||||
@@ -10,16 +10,16 @@ async function run() {
|
||||
});
|
||||
|
||||
const result = await sdk.video.getTimeline({
|
||||
ratingKey: 6788.8,
|
||||
ratingKey: 7206.33,
|
||||
key: "<key>",
|
||||
state: State.Playing,
|
||||
hasMDE: 7206.33,
|
||||
time: 6399.21,
|
||||
duration: 5820.2,
|
||||
state: State.Paused,
|
||||
hasMDE: 5820.2,
|
||||
time: 1433.53,
|
||||
duration: 5373.73,
|
||||
context: "string",
|
||||
playQueueItemID: 1433.53,
|
||||
playBackTime: 5373.73,
|
||||
row: 9446.69,
|
||||
playQueueItemID: 9446.69,
|
||||
playBackTime: 7586.16,
|
||||
row: 5218.48,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
|
||||
@@ -9,10 +9,10 @@ async function run() {
|
||||
});
|
||||
|
||||
const result = await sdk.video.startUniversalTranscode({
|
||||
hasMDE: 8009.11,
|
||||
path: "/private",
|
||||
mediaIndex: 5204.78,
|
||||
partIndex: 7805.29,
|
||||
hasMDE: 5204.78,
|
||||
path: "/usr/libexec",
|
||||
mediaIndex: 6788.8,
|
||||
partIndex: 1182.74,
|
||||
protocol: "string",
|
||||
});
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@ import Labels from "/src/lib/labels";
|
||||
name of the playlist
|
||||
|
||||
---
|
||||
##### `Type` *{`operations.Type`}*
|
||||
##### `Type` *{`operations.QueryParamType`}*
|
||||
type of playlist to create
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/query_param_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -6,10 +6,10 @@ import Labels from "/src/lib/labels";
|
||||
name of the playlist
|
||||
|
||||
---
|
||||
##### `type` *{`operations.Type`}*
|
||||
##### `type` *{`operations.QueryParamType`}*
|
||||
type of playlist to create
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/query_param_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -6,10 +6,10 @@ import Labels from "/src/lib/labels";
|
||||
name of the playlist
|
||||
|
||||
---
|
||||
##### `type`: *{`operations.TypeT`}*
|
||||
##### `type`: *{`operations.QueryParamType`}*
|
||||
type of playlist to create
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/type_t/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
<Collapsible content={() => import('/content/types/models/operations/query_param_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
|
||||
<br/>
|
||||
**Example:** `65592`
|
||||
|
||||
---
|
||||
##### `MixedParents` *{`*bool`}*
|
||||
<br/>
|
||||
**Example:** `true`
|
||||
|
||||
---
|
||||
##### `Metadata` *{`[]operations.GetLibraryItemsMetadata`}*
|
||||
<br/>
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]`
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_library_items_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
@@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
|
||||
<br/>
|
||||
**Example:** `65592`
|
||||
|
||||
---
|
||||
##### `mixed_parents` *{`Optional[bool]`}*
|
||||
<br/>
|
||||
**Example:** `true`
|
||||
|
||||
---
|
||||
##### `metadata` *{`List[operations.GetLibraryItemsMetadata]`}*
|
||||
<br/>
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]`
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_library_items_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
@@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
|
||||
<br/>
|
||||
**Example:** `65592`
|
||||
|
||||
---
|
||||
##### `mixedParents?`: *{`boolean`}*
|
||||
<br/>
|
||||
**Example:** `true`
|
||||
|
||||
---
|
||||
##### `metadata?`: *{`operations.GetLibraryItemsMetadata[]`}*
|
||||
<br/>
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]`
|
||||
**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]`
|
||||
|
||||
<Collapsible content={() => import('/content/types/models/operations/get_library_items_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
|
||||
|
||||
|
||||
@@ -111,6 +111,41 @@ import Labels from "/src/lib/labels";
|
||||
<br/>
|
||||
**Example:** `rottentomatoes://image.rating.ripe`
|
||||
|
||||
---
|
||||
##### `GrandparentRatingKey` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `66`
|
||||
|
||||
---
|
||||
##### `GrandparentGUID` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `plex://show/5d9c081b170e24001f2a7be4`
|
||||
|
||||
---
|
||||
##### `GrandparentKey` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66`
|
||||
|
||||
---
|
||||
##### `GrandparentTitle` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `Caprica`
|
||||
|
||||
---
|
||||
##### `GrandparentThumb` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66/thumb/1705716261`
|
||||
|
||||
---
|
||||
##### `GrandparentArt` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66/art/1705716261`
|
||||
|
||||
---
|
||||
##### `GrandparentTheme` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66/theme/1705716261`
|
||||
|
||||
---
|
||||
##### `Media` *{`[]operations.GetLibraryItemsMedia`}*
|
||||
<br/>
|
||||
@@ -189,4 +224,84 @@ import Labels from "/src/lib/labels";
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `Index` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `Theme` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/1/theme/1705636920`
|
||||
|
||||
---
|
||||
##### `LeafCount` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `14`
|
||||
|
||||
---
|
||||
##### `ViewedLeafCount` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `ChildCount` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `HasPremiumExtras` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `HasPremiumPrimaryExtra` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `ParentRatingKey` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `66`
|
||||
|
||||
---
|
||||
##### `ParentGUID` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `plex://show/5d9c081b170e24001f2a7be4`
|
||||
|
||||
---
|
||||
##### `ParentStudio` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `UCP`
|
||||
|
||||
---
|
||||
##### `ParentKey` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66`
|
||||
|
||||
---
|
||||
##### `ParentTitle` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `Caprica`
|
||||
|
||||
---
|
||||
##### `ParentIndex` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `ParentYear` *{`*int`}*
|
||||
<br/>
|
||||
**Example:** `2010`
|
||||
|
||||
---
|
||||
##### `ParentThumb` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66/thumb/1705716261`
|
||||
|
||||
---
|
||||
##### `ParentTheme` *{`*string`}*
|
||||
<br/>
|
||||
**Example:** `/library/metadata/66/theme/1705716261`
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user