mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-09 20:47:47 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.0
This commit is contained in:
speakeasybot
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/activities/string \
|
||||
curl http://10.10.10.47:32400/activities/<value> \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -10,18 +10,18 @@ curl http://10.10.10.47:32400/activities \
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 4375.87,
|
||||
"size": 0,
|
||||
"Activity": [
|
||||
{
|
||||
"uuid": "string",
|
||||
"type": "string",
|
||||
"uuid": "None",
|
||||
"type": "None",
|
||||
"cancellable": false,
|
||||
"userID": 2975.34,
|
||||
"title": "string",
|
||||
"subtitle": "string",
|
||||
"progress": 8917.73,
|
||||
"userID": 0,
|
||||
"title": "None",
|
||||
"subtitle": "None",
|
||||
"progress": 0,
|
||||
"Context": {
|
||||
"librarySectionID": "string"
|
||||
"librarySectionID": "None"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs?count=567.13 \
|
||||
curl http://10.10.10.47:32400/hubs?count=8121.69 \
|
||||
--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/hubs/sections/9636.63?count=2726.56 \
|
||||
curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \
|
||||
--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/hashes?type=8121.69&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
|
||||
curl http://10.10.10.47:32400/library/hashes?type=8360.79&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
|
||||
--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/sections/528895/{{tag}} \
|
||||
curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \
|
||||
--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 \
|
||||
curl http://10.10.10.47:32400/library/metadata/6481.72 \
|
||||
--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/9255.97/children \
|
||||
curl http://10.10.10.47:32400/library/metadata/202.18/children \
|
||||
--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/sections/4799.77/refresh \
|
||||
curl http://10.10.10.47:32400/library/sections/3373.96/refresh \
|
||||
--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/sections/568045/search \
|
||||
curl http://10.10.10.47:32400/library/sections/87129/search \
|
||||
--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/:/progress?key=string&state=string&time=3843.82 \
|
||||
curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=%3Cvalue%3E&time=7151.9 \
|
||||
--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/8326.2/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \
|
||||
curl http://10.10.10.47:32400/playlists/9786.19/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/3682.41/items \
|
||||
curl http://10.10.10.47:32400/playlists/8700.88/items \
|
||||
--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?playQueueID=8360.79&title=string&uri=string \
|
||||
curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&uri=%3Cvalue%3E \
|
||||
--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 \
|
||||
curl http://10.10.10.47:32400/playlists/9571.56 \
|
||||
--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/8326.2 \
|
||||
--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/6481.72/items?type=202.18 \
|
||||
curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \
|
||||
--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?summary=string&title=string \
|
||||
curl http://10.10.10.47:32400/playlists/7781.57?summary=%3Cvalue%3E&title=%3Cvalue%3E \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `X-Plex-Client-Identifier` _string_
|
||||
Plex Authentication Token
|
||||
The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
||||
|
||||
---
|
||||
##### `strong` _boolean (optional)_
|
||||
@@ -4,7 +4,7 @@
|
||||
curl https://plex.tv/api/v2/pins?strong=false \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
|
||||
--header 'X-Plex-Client-Identifier: string'
|
||||
--header 'X-Plex-Client-Identifier: <value>'
|
||||
```
|
||||
---
|
||||
|
||||
@@ -31,8 +31,8 @@ curl https://plex.tv/api/v2/pins?strong=false \
|
||||
"expiresIn": 1800,
|
||||
"createdAt": "2023-04-12T17:00:03Z",
|
||||
"expiresAt": "2023-04-12T17:30:03Z",
|
||||
"authToken": "string",
|
||||
"newRegistration": "string"
|
||||
"authToken": "None",
|
||||
"newRegistration": "None"
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Hubs*
|
||||
###### *Plex*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -0,0 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pinID` _string_
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `X-Plex-Client-Identifier` _string_
|
||||
The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl https://plex.tv/api/v2/pins/string \
|
||||
curl https://plex.tv/api/v2/pins/<value> \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
|
||||
--header 'X-Plex-Client-Identifier: string'
|
||||
--header 'X-Plex-Client-Identifier: <value>'
|
||||
```
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Hubs*
|
||||
###### *Plex*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -1,5 +1,17 @@
|
||||
import Tv from "./tv/tv.mdx";
|
||||
import GetPin from "./get_pin/get_pin.mdx";
|
||||
import GetToken from "./get_token/get_token.mdx";
|
||||
|
||||
## Plex
|
||||
API Calls that perform operations directly against https://Plex.tv
|
||||
|
||||
<Tv />
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Pin](/curl/plex/get_pin) - Get a Pin
|
||||
* [Get Token](/curl/plex/get_token) - Get Access Token
|
||||
|
||||
---
|
||||
<GetPin />
|
||||
|
||||
---
|
||||
<GetToken />
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex* / *Tv*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,8 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `pinID` _string_
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `X-Plex-Client-Identifier` _string_
|
||||
Plex Authentication Token
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex* / *Tv*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,15 +0,0 @@
|
||||
import GetPin from "./get_pin/get_pin.mdx";
|
||||
import GetToken from "./get_token/get_token.mdx";
|
||||
|
||||
## Tv
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Pin](/curl/plex/tv/get_pin) - Get a Pin
|
||||
* [Get Token](/curl/plex/tv/get_token) - Get Access Token
|
||||
|
||||
---
|
||||
<GetPin />
|
||||
|
||||
---
|
||||
<GetToken />
|
||||
@@ -4,6 +4,7 @@ group_type: flat
|
||||
|
||||
import Server from "./server/server.mdx";
|
||||
import Media from "./media/media.mdx";
|
||||
import Video from "./video/video.mdx";
|
||||
import Activities from "./activities/activities.mdx";
|
||||
import Butler from "./butler/butler.mdx";
|
||||
import Hubs from "./hubs/hubs.mdx";
|
||||
@@ -13,15 +14,18 @@ import Log from "./log/log.mdx";
|
||||
import Plex from "./plex/plex.mdx";
|
||||
import Playlists from "./playlists/playlists.mdx";
|
||||
import Security from "./security/security.mdx";
|
||||
import Statistics from "./statistics/statistics.mdx";
|
||||
import Sessions from "./sessions/sessions.mdx";
|
||||
import Updater from "./updater/updater.mdx";
|
||||
import Video from "./video/video.mdx";
|
||||
|
||||
<Server/>
|
||||
|
||||
---
|
||||
<Media/>
|
||||
|
||||
---
|
||||
<Video/>
|
||||
|
||||
---
|
||||
<Activities/>
|
||||
|
||||
@@ -49,12 +53,12 @@ import Video from "./video/video.mdx";
|
||||
---
|
||||
<Security/>
|
||||
|
||||
---
|
||||
<Statistics/>
|
||||
|
||||
---
|
||||
<Sessions/>
|
||||
|
||||
---
|
||||
<Updater/>
|
||||
|
||||
---
|
||||
<Video/>
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs/search?limit=5&query=arnold§ionId=4776.65 \
|
||||
curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=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/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=7917.25 \
|
||||
curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=9255.97 \
|
||||
--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/security/resources?source=provider%3A%2F%2Fprovider-identifier \
|
||||
curl http://10.10.10.47:32400/security/resources?source=server%3A%2F%2Fclient-identifier \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -17,7 +17,7 @@ curl http://10.10.10.47:32400/devices \
|
||||
"id": 1,
|
||||
"name": "iPhone",
|
||||
"platform": "iOS",
|
||||
"clientIdentifier": "string",
|
||||
"clientIdentifier": "None",
|
||||
"createdAt": 1654131230
|
||||
}
|
||||
]
|
||||
|
||||
@@ -13,7 +13,7 @@ curl http://10.10.10.47:32400/myplex/account \
|
||||
"authToken": "Z5v-PrNASDFpsaCi3CPK7",
|
||||
"username": "example.email@mail.com",
|
||||
"mappingState": "mapped",
|
||||
"mappingError": "string",
|
||||
"mappingError": "None",
|
||||
"signInState": "ok",
|
||||
"publicAddress": "140.20.68.140",
|
||||
"publicPort": 32400,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/photo/:/transcode?blur=20&height=165&opacity=623564&url=%2Flibrary%2Fmetadata%2F49564%2Fthumb%2F1654258204&width=110 \
|
||||
curl http://10.10.10.47:32400/photo/:/transcode?blur=20&height=165&opacity=548814&url=%2Flibrary%2Fmetadata%2F49564%2Fthumb%2F1654258204&width=110 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ curl http://10.10.10.47:32400/ \
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 5488.14,
|
||||
"size": 0,
|
||||
"allowCameraUpload": false,
|
||||
"allowChannelAccess": false,
|
||||
"allowMediaDeletion": false,
|
||||
@@ -20,51 +20,51 @@ curl http://10.10.10.47:32400/ \
|
||||
"backgroundProcessing": false,
|
||||
"certificate": false,
|
||||
"companionProxy": false,
|
||||
"countryCode": "string",
|
||||
"diagnostics": "string",
|
||||
"countryCode": "None",
|
||||
"diagnostics": "None",
|
||||
"eventStream": false,
|
||||
"friendlyName": "string",
|
||||
"friendlyName": "None",
|
||||
"hubSearch": false,
|
||||
"itemClusters": false,
|
||||
"livetv": 5928.45,
|
||||
"machineIdentifier": "string",
|
||||
"livetv": 0,
|
||||
"machineIdentifier": "None",
|
||||
"mediaProviders": false,
|
||||
"multiuser": false,
|
||||
"musicAnalysis": 7151.9,
|
||||
"musicAnalysis": 0,
|
||||
"myPlex": false,
|
||||
"myPlexMappingState": "string",
|
||||
"myPlexSigninState": "string",
|
||||
"myPlexMappingState": "None",
|
||||
"myPlexSigninState": "None",
|
||||
"myPlexSubscription": false,
|
||||
"myPlexUsername": "string",
|
||||
"offlineTranscode": 8442.66,
|
||||
"ownerFeatures": "string",
|
||||
"myPlexUsername": "None",
|
||||
"offlineTranscode": 0,
|
||||
"ownerFeatures": "None",
|
||||
"photoAutoTag": false,
|
||||
"platform": "string",
|
||||
"platformVersion": "string",
|
||||
"platform": "None",
|
||||
"platformVersion": "None",
|
||||
"pluginHost": false,
|
||||
"pushNotifications": false,
|
||||
"readOnlyLibraries": false,
|
||||
"streamingBrainABRVersion": 6027.63,
|
||||
"streamingBrainVersion": 8579.46,
|
||||
"streamingBrainABRVersion": 0,
|
||||
"streamingBrainVersion": 0,
|
||||
"sync": false,
|
||||
"transcoderActiveVideoSessions": 5448.83,
|
||||
"transcoderActiveVideoSessions": 0,
|
||||
"transcoderAudio": false,
|
||||
"transcoderLyrics": false,
|
||||
"transcoderPhoto": false,
|
||||
"transcoderSubtitles": false,
|
||||
"transcoderVideo": false,
|
||||
"transcoderVideoBitrates": "string",
|
||||
"transcoderVideoQualities": "string",
|
||||
"transcoderVideoResolutions": "string",
|
||||
"updatedAt": 8472.52,
|
||||
"transcoderVideoBitrates": "None",
|
||||
"transcoderVideoQualities": "None",
|
||||
"transcoderVideoResolutions": "None",
|
||||
"updatedAt": 0,
|
||||
"updater": false,
|
||||
"version": "string",
|
||||
"version": "None",
|
||||
"voiceSearch": false,
|
||||
"Directory": [
|
||||
{
|
||||
"count": 4236.55,
|
||||
"key": "string",
|
||||
"title": "string"
|
||||
"count": 0,
|
||||
"key": "None",
|
||||
"title": "None"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -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,7 @@
|
||||
import OperationInfo from '/src/components/OperationInfo';
|
||||
|
||||
## Get Statistics
|
||||
|
||||
<OperationInfo method='get' path='/statistics/media' />
|
||||
|
||||
This will return the media statistics for the server
|
||||
@@ -0,0 +1,6 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `Timespan` _integer (optional)_
|
||||
The timespan to retrieve statistics for
|
||||
the exact meaning of this parameter is not known
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetStatisticsMediaContainer from "/content/types/operations/get_statistics_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}>
|
||||
<GetStatisticsMediaContainer/>
|
||||
</Collapsible>
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"400"} />}>
|
||||
_No response body._
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"401"} />}>
|
||||
*JSON object*
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
##### `errors` _array (optional)_
|
||||
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
</TabbedSection>
|
||||
@@ -0,0 +1,20 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 5497,
|
||||
"Device": [],
|
||||
"Account": [],
|
||||
"StatisticsMedia": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Activities*
|
||||
###### *Statistics*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -0,0 +1,12 @@
|
||||
import GetStatistics from "./get_statistics/get_statistics.mdx";
|
||||
|
||||
## Statistics
|
||||
API Calls that perform operations with Plex Media Server Statistics
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Statistics](/curl/statistics/get_statistics) - Get Media Statistics
|
||||
|
||||
---
|
||||
<GetStatistics />
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
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 \
|
||||
curl http://10.10.10.47:32400/:/timeline?context=%3Cvalue%3E&duration=5448.83&hasMDE=6027.63&key=%3Cvalue%3E&playBackTime=4236.55&playQueueItemID=8472.52&ratingKey=8442.66&row=6235.64&time=8579.46 \
|
||||
--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=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 \
|
||||
curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4776.65&audioBoost=2726.56&autoAdjustQuality=7917.25&directPlay=8917.73&directStream=567.13&fastSeek=2975.34&hasMDE=6458.94&location=%3Cvalue%3E&mediaBufferSize=3834.41&mediaIndex=3843.82&partIndex=4375.87&path=%3Cvalue%3E&protocol=%3Cvalue%3E&session=%3Cvalue%3E&subtites=%3Cvalue%3E&subtitleSize=9636.63 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import StartUniversalTranscode from "./start_universal_transcode/start_universal_transcode.mdx";
|
||||
import GetTimeline from "./get_timeline/get_timeline.mdx";
|
||||
import StartUniversalTranscode from "./start_universal_transcode/start_universal_transcode.mdx";
|
||||
|
||||
## Video
|
||||
API Calls that perform operations with Plex Media Server Videos
|
||||
@@ -7,11 +7,11 @@ API Calls that perform operations with Plex Media Server Videos
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Start Universal Transcode](/curl/video/start_universal_transcode) - Start Universal Transcode
|
||||
* [Get Timeline](/curl/video/get_timeline) - Get the timeline for a media item
|
||||
|
||||
---
|
||||
<StartUniversalTranscode />
|
||||
* [Start Universal Transcode](/curl/video/start_universal_transcode) - Start Universal Transcode
|
||||
|
||||
---
|
||||
<GetTimeline />
|
||||
|
||||
---
|
||||
<StartUniversalTranscode />
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
import SDKPicker from '/src/components/SDKPicker';
|
||||
|
||||
We offer native client SDKs in the following languages. Select a language to view documentation and usage examples for that language.
|
||||
|
||||
<SDKPicker />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Client SDKs
|
||||
|
||||
{/* render client_sdks */}
|
||||
@@ -1,6 +0,0 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Custom HTTP Client <LanguageSelector/></H2>
|
||||
|
||||
{/* render custom_http_client */}
|
||||
@@ -1,6 +0,0 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Errors <LanguageSelector/></H2>
|
||||
|
||||
{/* render errors */}
|
||||
@@ -1,6 +0,0 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Installation <LanguageSelector/></H2>
|
||||
|
||||
{/* render installation */}
|
||||
@@ -1,23 +0,0 @@
|
||||
import GetServerActivities from "./get_server_activities/get_server_activities.mdx";
|
||||
import CancelServerActivities from "./cancel_server_activities/cancel_server_activities.mdx";
|
||||
|
||||
## Activities
|
||||
Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real\-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
||||
Activities are associated with HTTP replies via a special `X\-Plex\-Activity` header which contains the UUID of the activity.
|
||||
Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details:
|
||||
\- They can contain a `progress` (from 0 to 100) marking the percent completion of the activity.
|
||||
\- They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||
\- They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||
\- The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Server Activities](/go/activities/get_server_activities) - Get Server Activities
|
||||
* [Cancel Server Activities](/go/activities/cancel_server_activities) - Cancel Server Activities
|
||||
|
||||
---
|
||||
<GetServerActivities />
|
||||
|
||||
---
|
||||
<CancelServerActivities />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Cancel Server Activities
|
||||
|
||||
Cancel Server Activities
|
||||
@@ -1,8 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
---
|
||||
##### `activityUUID` *{`string`}*
|
||||
The UUID of the activity to cancel.
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import CancelServerActivitiesResponse from "/content/types/models/operations/cancel_server_activities_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.CancelServerActivitiesResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<CancelServerActivitiesResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go CancelServerActivities.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var activityUUID string = "string"
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Activities.CancelServerActivities(ctx, activityUUID)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Server Activities
|
||||
|
||||
Get Server Activities
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetServerActivitiesResponse from "/content/types/models/operations/get_server_activities_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetServerActivitiesResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetServerActivitiesResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetServerActivities.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Activities.GetServerActivities(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 6235.64,
|
||||
"Activity": [
|
||||
{
|
||||
"uuid": "string",
|
||||
"type": "string",
|
||||
"cancellable": false,
|
||||
"userID": 6458.94,
|
||||
"title": "string",
|
||||
"subtitle": "string",
|
||||
"progress": 3843.82,
|
||||
"Context": {
|
||||
"librarySectionID": "string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,32 +0,0 @@
|
||||
import GetButlerTasks from "./get_butler_tasks/get_butler_tasks.mdx";
|
||||
import StartAllTasks from "./start_all_tasks/start_all_tasks.mdx";
|
||||
import StopAllTasks from "./stop_all_tasks/stop_all_tasks.mdx";
|
||||
import StartTask from "./start_task/start_task.mdx";
|
||||
import StopTask from "./stop_task/stop_task.mdx";
|
||||
|
||||
## Butler
|
||||
Butler is the task manager of the Plex Media Server Ecosystem.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Butler Tasks](/go/butler/get_butler_tasks) - Get Butler tasks
|
||||
* [Start All Tasks](/go/butler/start_all_tasks) - Start all Butler tasks
|
||||
* [Stop All Tasks](/go/butler/stop_all_tasks) - Stop all Butler tasks
|
||||
* [Start Task](/go/butler/start_task) - Start a single Butler task
|
||||
* [Stop Task](/go/butler/stop_task) - Stop a single Butler task
|
||||
|
||||
---
|
||||
<GetButlerTasks />
|
||||
|
||||
---
|
||||
<StartAllTasks />
|
||||
|
||||
---
|
||||
<StopAllTasks />
|
||||
|
||||
---
|
||||
<StartTask />
|
||||
|
||||
---
|
||||
<StopTask />
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Butler Tasks
|
||||
|
||||
Returns a list of butler tasks
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetButlerTasksResponse from "/content/types/models/operations/get_butler_tasks_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetButlerTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetButlerTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetButlerTasks.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Butler.GetButlerTasks(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"ButlerTasks": {
|
||||
"ButlerTask": [
|
||||
{
|
||||
"name": "BackupDatabase",
|
||||
"interval": 3,
|
||||
"scheduleRandomized": false,
|
||||
"enabled": false,
|
||||
"title": "Backup Database",
|
||||
"description": "Create a backup copy of the server's database in the configured backup directory"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,7 +0,0 @@
|
||||
## Start All Tasks
|
||||
|
||||
This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||
1. Any tasks not scheduled to run on the current day will be skipped.
|
||||
2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||
3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||
4. If we are outside the configured window, the task will start immediately.
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StartAllTasksResponse from "/content/types/models/operations/start_all_tasks_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.StartAllTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StartAllTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go StartAllTasks.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Butler.StartAllTasks(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,7 +0,0 @@
|
||||
## Start Task
|
||||
|
||||
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||
1. Any tasks not scheduled to run on the current day will be skipped.
|
||||
2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||
3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||
4. If we are outside the configured window, the task will start immediately.
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import TaskName from "/content/types/models/operations/task_name/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.
|
||||
|
||||
---
|
||||
##### `taskName` *{`operations.TaskName`}*
|
||||
the name of the task to be started.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<TaskName />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StartTaskResponse from "/content/types/models/operations/start_task_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.StartTaskResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StartTaskResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go StartTask.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var taskName operations.TaskName = operations.TaskNameRefreshPeriodicMetadata
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Butler.StartTask(ctx, taskName)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Stop All Tasks
|
||||
|
||||
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||
@@ -1,4 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
|
||||
The context to use for the request.
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StopAllTasksResponse from "/content/types/models/operations/stop_all_tasks_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.StopAllTasksResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StopAllTasksResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go StopAllTasks.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Butler.StopAllTasks(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Stop Task
|
||||
|
||||
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import PathParamTaskName from "/content/types/models/operations/path_param_task_name/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.
|
||||
|
||||
---
|
||||
##### `taskName` *{`operations.PathParamTaskName`}*
|
||||
The name of the task to be started.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<PathParamTaskName />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import StopTaskResponse from "/content/types/models/operations/stop_task_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.StopTaskResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<StopTaskResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go StopTask.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var taskName operations.PathParamTaskName = operations.PathParamTaskNameGenerateChapterThumbs
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Butler.StopTask(ctx, taskName)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.StatusCode == http.StatusOK {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Butler*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Global Hubs
|
||||
|
||||
Get Global Hubs filtered by the parameters provided.
|
||||
@@ -1,20 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import OnlyTransient from "/content/types/models/operations/only_transient/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.
|
||||
|
||||
---
|
||||
##### `count` *{`*float64`}*
|
||||
The number of items to return with each hub.
|
||||
|
||||
---
|
||||
##### `onlyTransient` *{`*operations.OnlyTransient`}*
|
||||
Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<OnlyTransient />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetGlobalHubsResponse from "/content/types/models/operations/get_global_hubs_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetGlobalHubsResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetGlobalHubsResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetGlobalHubs.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 count *float64 = 8472.52
|
||||
|
||||
var onlyTransient *operations.OnlyTransient = operations.OnlyTransientZero
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Hubs.GetGlobalHubs(ctx, count, onlyTransient)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 8,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"Hub": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Library Hubs
|
||||
|
||||
This endpoint will return a list of library specific hubs
|
||||
@@ -1,24 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import QueryParamOnlyTransient from "/content/types/models/operations/query_param_only_transient/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` *{`float64`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `count` *{`*float64`}*
|
||||
The number of items to return with each hub.
|
||||
|
||||
---
|
||||
##### `onlyTransient` *{`*operations.QueryParamOnlyTransient`}*
|
||||
Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<QueryParamOnlyTransient />
|
||||
</Collapsible>
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
import GetLibraryHubsResponse from "/content/types/models/operations/get_library_hubs_response/go.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`*operations.GetLibraryHubsResponse`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetLibraryHubsResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetLibraryHubs.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 float64 = 6235.64
|
||||
|
||||
var count *float64 = 6458.94
|
||||
|
||||
var onlyTransient *operations.QueryParamOnlyTransient = operations.QueryParamOnlyTransientZero
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Hubs.GetLibraryHubs(ctx, sectionID, count, onlyTransient)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 7,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"Hub": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,17 +0,0 @@
|
||||
import GetGlobalHubs from "./get_global_hubs/get_global_hubs.mdx";
|
||||
import GetLibraryHubs from "./get_library_hubs/get_library_hubs.mdx";
|
||||
|
||||
## Hubs
|
||||
Hubs are a structured two\-dimensional container for media, generally represented by multiple horizontal rows.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Global Hubs](/go/hubs/get_global_hubs) - Get Global Hubs
|
||||
* [Get Library Hubs](/go/hubs/get_library_hubs) - Get library specific hubs
|
||||
|
||||
---
|
||||
<GetGlobalHubs />
|
||||
|
||||
---
|
||||
<GetLibraryHubs />
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user