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.147.0
This commit is contained in:
speakeasybot
@@ -10,4 +10,3 @@ the name of the task to be started.
|
||||
<TaskName />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,3 @@ The name of the task to be started.
|
||||
<PathParamTaskName />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `count` *{`Optional[float]`}*
|
||||
The number of items to return with each hub.
|
||||
|
||||
---
|
||||
##### `only_transient` *{`Optional[operations.OnlyTransient]`}*
|
||||
Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
||||
@@ -13,4 +14,3 @@ Only return hubs which are "transient", meaning those which are prone to changin
|
||||
<OnlyTransient />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -5,9 +5,11 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `count` *{`Optional[float]`}*
|
||||
The number of items to return with each hub.
|
||||
|
||||
---
|
||||
##### `only_transient` *{`Optional[operations.QueryParamOnlyTransient]`}*
|
||||
Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
|
||||
@@ -16,4 +18,3 @@ Only return hubs which are "transient", meaning those which are prone to changin
|
||||
<QueryParamOnlyTransient />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` *{`float`}*
|
||||
item type
|
||||
|
||||
---
|
||||
##### `filter_` *{`Optional[str]`}*
|
||||
the filter parameter
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
This is the path to the local file, must be prefixed by `file://`
|
||||
<br/>
|
||||
**Example:** `file://C:\Image.png&type=13`
|
||||
|
||||
---
|
||||
##### `type` *{`Optional[float]`}*
|
||||
Item type
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` *{`float`}*
|
||||
item type
|
||||
|
||||
---
|
||||
##### `filter_` *{`Optional[str]`}*
|
||||
the filter parameter
|
||||
|
||||
@@ -10,7 +10,7 @@ s = plex_api.PlexAPI(
|
||||
|
||||
res = s.library.get_libraries()
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -18,13 +18,12 @@ if res.status_code == 200:
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
"MediaContainer": {
|
||||
"size": 5,
|
||||
"allowSync": false,
|
||||
"title1": "Plex Library",
|
||||
"Directory": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
|
||||
@@ -7,6 +7,7 @@ import Labels from "/src/lib/labels";
|
||||
the Id of the library to query
|
||||
<br/>
|
||||
**Example:** `1000`
|
||||
|
||||
---
|
||||
##### `include_details` *{`Optional[operations.IncludeDetails]`}*
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
@@ -17,4 +18,3 @@ Only exists for backwards compatibility, media providers other than the server l
|
||||
<IncludeDetails />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` *{`Optional[float]`}*
|
||||
item type
|
||||
|
||||
---
|
||||
##### `filter_` *{`Optional[str]`}*
|
||||
the filter parameter
|
||||
|
||||
@@ -19,6 +19,7 @@ An integer log level to write to the PMS log with.
|
||||
---
|
||||
##### `message` *{`str`}*
|
||||
The text of the message to write to the log.
|
||||
|
||||
---
|
||||
##### `source` *{`str`}*
|
||||
a string indicating the source of the message.
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `key` *{`str`}*
|
||||
the media key
|
||||
|
||||
---
|
||||
##### `time` *{`float`}*
|
||||
The time, in milliseconds, used to set the media playback progress.
|
||||
|
||||
---
|
||||
##### `state` *{`str`}*
|
||||
The playback state of the media item.
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `playlist_id` *{`float`}*
|
||||
the ID of the playlist
|
||||
|
||||
---
|
||||
##### `uri` *{`str`}*
|
||||
the content URI for the playlist
|
||||
<br/>
|
||||
**Example:** `library://..`
|
||||
|
||||
---
|
||||
##### `play_queue_id` *{`float`}*
|
||||
the play queue to add to a playlist
|
||||
|
||||
@@ -10,4 +10,3 @@ The request object to use for the request.
|
||||
<CreatePlaylistRequest />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `playlist_id` *{`float`}*
|
||||
the ID of the playlist
|
||||
|
||||
---
|
||||
##### `type` *{`float`}*
|
||||
the metadata type of the item to return
|
||||
|
||||
@@ -19,4 +19,3 @@ type of playlists to return (default is all).
|
||||
<QueryParamSmart />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -13,6 +13,7 @@ The GUID of each playlist is based on the filename.
|
||||
|
||||
<br/>
|
||||
**Example:** `/home/barkley/playlist.m3u`
|
||||
|
||||
---
|
||||
##### `force` *{`operations.Force`}*
|
||||
force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
@@ -23,4 +24,3 @@ The `force` argument is used to disable overwriting. If the `force` argument is
|
||||
<Force />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -3,9 +3,11 @@
|
||||
The query term
|
||||
<br/>
|
||||
**Example:** `arnold`
|
||||
|
||||
---
|
||||
##### `section_id` *{`Optional[float]`}*
|
||||
This gives context to the search, and can result in re\-ordering of search result hubs
|
||||
|
||||
---
|
||||
##### `limit` *{`Optional[float]`}*
|
||||
The number of items to return per hub
|
||||
|
||||
@@ -3,9 +3,11 @@
|
||||
The query term
|
||||
<br/>
|
||||
**Example:** `dead+poop`
|
||||
|
||||
---
|
||||
##### `section_id` *{`Optional[float]`}*
|
||||
This gives context to the search, and can result in re\-ordering of search result hubs
|
||||
|
||||
---
|
||||
##### `limit` *{`Optional[float]`}*
|
||||
The number of items to return per hub
|
||||
|
||||
@@ -19,4 +19,3 @@ import Labels from "/src/lib/labels";
|
||||
<Scope />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,3 @@ The request object to use for the request.
|
||||
<GetResizedPhotoRequest />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -19,4 +19,3 @@ Indicate that the latest version should be marked as skipped. The \<Release\> en
|
||||
<Skip />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,3 @@ Indicate that you want to start download any updates found.
|
||||
<Download />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,3 @@ The request object to use for the request.
|
||||
<GetTimelineRequest />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -10,4 +10,3 @@ The request object to use for the request.
|
||||
<StartUniversalTranscodeRequest />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user