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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0

Browse Source
This commit is contained in:
speakeasybot
2024-01-24 00:32:49 +00:00
parent e044084015
commit 64a942a910
254 changed files with 2806 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx
View File

@@ -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.

1
content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx
View File

@@ -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": []
}
}

2
content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx
View File

@@ -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
content/pages/01-reference/curl/resources/library/library.mdx
View File

@@ -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 />

9
content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx Normal file
View File

@@ -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>`

25
content/pages/01-reference/curl/resources/library/search_library/_header.mdx Normal file
View File

@@ -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.

16
content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx Normal file
View File

@@ -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>

22
content/pages/01-reference/curl/resources/library/search_library/_response.mdx Normal file
View File

@@ -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>

29
content/pages/01-reference/curl/resources/library/search_library/_usage.mdx Normal file
View File

@@ -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>

12
content/pages/01-reference/curl/resources/library/search_library/search_library.mdx Normal file
View File

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

2
content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx
View File

@@ -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'
```

4
content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx
View File

@@ -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>
---

2
content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx
View File

@@ -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'
```

4
content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx
View File

@@ -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>
---

2
content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx
View File

@@ -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'
```

2
content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx
View File

@@ -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'
```