ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.147.0

This commit is contained in:
speakeasybot
2024-01-19 00:32:18 +00:00
parent efa711c3a2
commit 26c128571f
323 changed files with 1244 additions and 151 deletions

View File

@@ -1,17 +1,17 @@
lockVersion: 2.0.0
id: 7fc33f51-d778-40ef-b094-90972c025d39
management:
docChecksum: 34d22936f2456c2c461abdfc773e3fc4
docChecksum: d7e0ebb6913e00a62d90ea05f2e5542d
docVersion: 0.0.3
speakeasyVersion: internal
generationVersion: 2.235.3
releaseVersion: 0.1.0
configChecksum: 96b7a3b4b875dd83be35e7433e294291
generationVersion: 2.237.2
releaseVersion: 0.1.1
configChecksum: 0c20dc849e2f416cfc75b0f5279fd965
published: true
features:
docs:
constsAndDefaults: 0.1.0
core: 1.24.1
core: 1.24.2
flattening: 0.1.0
globalSecurity: 0.1.1
globalServerURLs: 0.1.1
@@ -1311,9 +1311,18 @@ generatedFiles:
- content/types/models/operations/get_latest_library_items_response/go.mdx
- content/types/models/operations/get_latest_library_items_response/python.mdx
- content/types/models/operations/get_latest_library_items_response/typescript.mdx
- content/types/models/operations/get_libraries_directory/go.mdx
- content/types/models/operations/get_libraries_directory/python.mdx
- content/types/models/operations/get_libraries_directory/typescript.mdx
- content/types/models/operations/get_libraries_media_container/go.mdx
- content/types/models/operations/get_libraries_media_container/python.mdx
- content/types/models/operations/get_libraries_media_container/typescript.mdx
- content/types/models/operations/get_libraries_response/go.mdx
- content/types/models/operations/get_libraries_response/python.mdx
- content/types/models/operations/get_libraries_response/typescript.mdx
- content/types/models/operations/get_libraries_response_body/go.mdx
- content/types/models/operations/get_libraries_response_body/python.mdx
- content/types/models/operations/get_libraries_response_body/typescript.mdx
- content/types/models/operations/get_library_hubs_request/go.mdx
- content/types/models/operations/get_library_hubs_request/python.mdx
- content/types/models/operations/get_library_hubs_request/typescript.mdx
@@ -1521,6 +1530,9 @@ generatedFiles:
- content/types/models/operations/level/go.mdx
- content/types/models/operations/level/python.mdx
- content/types/models/operations/level/typescript.mdx
- content/types/models/operations/location/go.mdx
- content/types/models/operations/location/python.mdx
- content/types/models/operations/location/typescript.mdx
- content/types/models/operations/log_line_request/go.mdx
- content/types/models/operations/log_line_request/python.mdx
- content/types/models/operations/log_line_request/typescript.mdx
@@ -2307,6 +2319,10 @@ generatedFiles:
- content/types/operations/get_recently_added_response_body/curl.mdx
- content/types/operations/get_recently_added_response/curl.mdx
- content/types/operations/get_libraries_errors/curl.mdx
- content/types/operations/get_libraries_library_response_body/curl.mdx
- content/types/operations/location/curl.mdx
- content/types/operations/get_libraries_directory/curl.mdx
- content/types/operations/get_libraries_media_container/curl.mdx
- content/types/operations/get_libraries_response_body/curl.mdx
- content/types/operations/get_libraries_response/curl.mdx
- content/types/operations/include_details/curl.mdx

View File

@@ -23,3 +23,9 @@ Based on:
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.142.3 (2.235.3) https://github.com/speakeasy-api/speakeasy
## 2024-01-19 00:30:36
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy

View File

@@ -10,4 +10,3 @@ the name of the task to be started.
<TaskName />
</Collapsible>

View File

@@ -10,4 +10,3 @@ The name of the task to be started.
<PathParamTaskName />
</Collapsible>

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `count` _number (optional)_
The number of items to return with each hub.
---
##### `onlyTransient` _enumeration (optional)_
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>

View File

@@ -5,9 +5,11 @@ import Labels from "/src/lib/labels";
##### `sectionId` _number_
the Id of the library to query
---
##### `count` _number (optional)_
The number of items to return with each hub.
---
##### `onlyTransient` _enumeration (optional)_
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>

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `sectionId` _number_
the Id of the library to query
---
##### `type` _number_
item type
---
##### `filter` _string (optional)_
the filter parameter

View File

@@ -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` _number (optional)_
Item type

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `sectionId` _number_
the Id of the library to query
---
##### `type` _number_
item type
---
##### `filter` _string (optional)_
the filter parameter

View File

@@ -1,4 +1,5 @@
{/* Autogenerated DO NOT EDIT */}
import GetLibrariesMediaContainer from "/content/types/operations/get_libraries_media_container/curl.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
@@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLibrariesMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/library/sections \
```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>

View File

@@ -7,6 +7,7 @@ import Labels from "/src/lib/labels";
the Id of the library to query
<br/>
**Example:** `1000`
---
##### `includeDetails` _enumeration (optional)_
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>

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `sectionId` _number_
the Id of the library to query
---
##### `type` _number (optional)_
item type
---
##### `filter` _string (optional)_
the filter parameter

View File

@@ -19,6 +19,7 @@ An integer log level to write to the PMS log with.
---
##### `message` _string_
The text of the message to write to the log.
---
##### `source` _string_
a string indicating the source of the message.

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `key` _string_
the media key
---
##### `time` _number_
The time, in milliseconds, used to set the media playback progress.
---
##### `state` _string_
The playback state of the media item.

View File

@@ -1,11 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `playlistID` _number_
the ID of the playlist
---
##### `uri` _string_
the content URI for the playlist
<br/>
**Example:** `library://..`
---
##### `playQueueID` _number_
the play queue to add to a playlist

View File

@@ -6,6 +6,7 @@ import Labels from "/src/lib/labels";
##### `title` _string_
name of the playlist
---
##### `type` _enumeration_
type of playlist to create
@@ -25,6 +26,7 @@ whether the playlist is smart or not
---
##### `uri` _string (optional)_
the content URI for the playlist
---
##### `playQueueID` _number (optional)_
the play queue to copy to a playlist

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `playlistID` _number_
the ID of the playlist
---
##### `type` _number_
the metadata type of the item to return

View File

@@ -19,4 +19,3 @@ type of playlists to return (default is all).
<QueryParamSmart />
</Collapsible>

View File

@@ -13,6 +13,7 @@ The GUID of each playlist is based on the filename.
<br/>
**Example:** `/home/barkley/playlist.m3u`
---
##### `force` _enumeration_
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>

View File

@@ -3,9 +3,11 @@
The query term
<br/>
**Example:** `arnold`
---
##### `sectionId` _number (optional)_
This gives context to the search, and can result in re\-ordering of search result hubs
---
##### `limit` _number (optional)_
The number of items to return per hub

View File

@@ -3,9 +3,11 @@
The query term
<br/>
**Example:** `dead+poop`
---
##### `sectionId` _number (optional)_
This gives context to the search, and can result in re\-ordering of search result hubs
---
##### `limit` _number (optional)_
The number of items to return per hub

View File

@@ -19,4 +19,3 @@ import Labels from "/src/lib/labels";
<Scope />
</Collapsible>

View File

@@ -8,19 +8,23 @@ import Labels from "/src/lib/labels";
The width for the resized photo
<br/>
**Example:** `110`
---
##### `height` _number_
The height for the resized photo
<br/>
**Example:** `165`
---
##### `opacity` _integer_
The opacity for the resized photo
---
##### `blur` _number_
The width for the resized photo
<br/>
**Example:** `0`
---
##### `minSize` _enumeration_
images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against.

View File

@@ -19,4 +19,3 @@ Indicate that the latest version should be marked as skipped. The \<Release\> en
<Skip />
</Collapsible>

View File

@@ -10,4 +10,3 @@ Indicate that you want to start download any updates found.
<Download />
</Collapsible>

View File

@@ -5,9 +5,11 @@ import Labels from "/src/lib/labels";
##### `ratingKey` _number_
The rating key of the media item
---
##### `key` _string_
The key of the media item to get the timeline for
---
##### `state` _enumeration_
The state of the media item
@@ -19,21 +21,27 @@ The state of the media item
---
##### `hasMDE` _number_
Whether the media item has MDE
---
##### `time` _number_
The time of the media item
---
##### `duration` _number_
The duration of the media item
---
##### `context` _string_
The context of the media item
---
##### `playQueueItemID` _number_
The play queue item ID of the media item
---
##### `playBackTime` _number_
The playback time of the media item
---
##### `row` _number_
The row of the media item

View File

@@ -1,48 +1,63 @@
{/* Autogenerated DO NOT EDIT */}
##### `hasMDE` _number_
Whether the media item has MDE
---
##### `path` _string_
The path to the media item to transcode
---
##### `mediaIndex` _number_
The index of the media item to transcode
---
##### `partIndex` _number_
The index of the part to transcode
---
##### `protocol` _string_
The protocol to use for the transcode session
---
##### `fastSeek` _number (optional)_
Whether to use fast seek or not
---
##### `directPlay` _number (optional)_
Whether to use direct play or not
---
##### `directStream` _number (optional)_
Whether to use direct stream or not
---
##### `subtitleSize` _number (optional)_
The size of the subtitles
---
##### `subtites` _string (optional)_
The subtitles
---
##### `audioBoost` _number (optional)_
The audio boost
---
##### `location` _string (optional)_
The location of the transcode session
---
##### `mediaBufferSize` _number (optional)_
The size of the media buffer
---
##### `session` _string (optional)_
The session ID
---
##### `addDebugOverlay` _number (optional)_
Whether to add a debug overlay or not
---
##### `autoAdjustQuality` _number (optional)_
Whether to auto adjust quality or not

View File

@@ -1,6 +1,7 @@
{/* 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.

View File

@@ -5,6 +5,7 @@ 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.
@@ -13,4 +14,3 @@ the name of the task to be started.
<TaskName />
</Collapsible>

View File

@@ -5,6 +5,7 @@ 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.
@@ -13,4 +14,3 @@ The name of the task to be started.
<PathParamTaskName />
</Collapsible>

View File

@@ -5,9 +5,11 @@ 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).
@@ -16,4 +18,3 @@ Only return hubs which are "transient", meaning those which are prone to changin
<OnlyTransient />
</Collapsible>

View File

@@ -5,12 +5,15 @@ 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).
@@ -19,4 +22,3 @@ Only return hubs which are "transient", meaning those which are prone to changin
<QueryParamOnlyTransient />
</Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `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

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */}
##### `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
---
##### `type_` *{`float64`}*
item type
---
##### `filter` *{`*string`}*
the filter parameter

View File

@@ -1,11 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `url_` *{`string`}*
This is the path to the local file, must be prefixed by `file://`
<br/>
**Example:** `file://C:\Image.png&type=13`
---
##### `type_` *{`*float64`}*
Item type

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */}
##### `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
---
##### `type_` *{`float64`}*
item type
---
##### `filter` *{`*string`}*
the filter parameter

View File

@@ -8,7 +8,6 @@ import(
"github.com/LukeHagar/plexgo"
"context"
"log"
"net/http"
)
func main() {
@@ -22,7 +21,7 @@ func main() {
log.Fatal(err)
}
if res.StatusCode == http.StatusOK {
if res.Object != nil {
// handle response
}
}
@@ -31,13 +30,12 @@ func main() {
```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>

View File

@@ -5,11 +5,13 @@ 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
<br/>
**Example:** `1000`
---
##### `includeDetails` *{`*operations.IncludeDetails`}*
Whether or not to include details for a section (types, filters, and sorts).
@@ -20,4 +22,3 @@ Only exists for backwards compatibility, media providers other than the server l
<IncludeDetails />
</Collapsible>

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */}
##### `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
---
##### `type_` *{`*float64`}*
item type
---
##### `filter` *{`*string`}*
the filter parameter

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `ratingKey` *{`float64`}*
the id of the library item to return the children of.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `ratingKey` *{`float64`}*
the id of the library item to return the children of.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `sectionID` *{`float64`}*
the Id of the library to refresh

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `level` *{`operations.Level`}*
An integer log level to write to the PMS log with.
@@ -22,6 +23,7 @@ An integer log level to write to the PMS log with.
---
##### `message` *{`string`}*
The text of the message to write to the log.
---
##### `source` *{`string`}*
a string indicating the source of the message.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `key` *{`float64`}*
The media key to mark as played

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `key` *{`float64`}*
The media key to mark as Unplayed

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `key` *{`string`}*
the media key
---
##### `time` *{`float64`}*
The time, in milliseconds, used to set the media playback progress.
---
##### `state` *{`string`}*
The playback state of the media item.

View File

@@ -1,14 +1,17 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist
---
##### `uri` *{`string`}*
the content URI for the playlist
<br/>
**Example:** `library://..`
---
##### `playQueueID` *{`float64`}*
the play queue to add to a playlist

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `request` *{`operations.CreatePlaylistRequest`}*
The request object to use for the request.
@@ -13,4 +14,3 @@ The request object to use for the request.
<CreatePlaylistRequest />
</Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist
---
##### `type_` *{`float64`}*
the metadata type of the item to return

View File

@@ -6,6 +6,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistType` *{`*operations.PlaylistType`}*
limit to a type of playlist.
@@ -22,4 +23,3 @@ type of playlists to return (default is all).
<QueryParamSmart />
</Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `playlistID` *{`float64`}*
the ID of the playlist

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `path` *{`string`}*
absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.
@@ -16,6 +17,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.
@@ -26,4 +28,3 @@ The `force` argument is used to disable overwriting. If the `force` argument is
<Force />
</Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `query` *{`string`}*
The search query string to use

View File

@@ -1,14 +1,17 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `query` *{`string`}*
The query term
<br/>
**Example:** `arnold`
---
##### `sectionID` *{`*float64`}*
This gives context to the search, and can result in re\-ordering of search result hubs
---
##### `limit` *{`*float64`}*
The number of items to return per hub

View File

@@ -1,14 +1,17 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `query` *{`string`}*
The query term
<br/>
**Example:** `dead+poop`
---
##### `sectionID` *{`*float64`}*
This gives context to the search, and can result in re\-ordering of search result hubs
---
##### `limit` *{`*float64`}*
The number of items to return per hub

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `source` *{`string`}*
The source identifier with an included prefix.

View File

@@ -6,6 +6,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `type_` *{`operations.QueryParamType`}*
`delegation` \- This is the only supported `type` parameter.
@@ -22,4 +23,3 @@ The context to use for the request.
<Scope />
</Collapsible>

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `request` *{`operations.GetResizedPhotoRequest`}*
The request object to use for the request.
@@ -13,4 +14,3 @@ The request object to use for the request.
<GetResizedPhotoRequest />
</Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `sessionKey` *{`string`}*
the Key of the transcode session to stop

View File

@@ -6,6 +6,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `tonight` *{`*operations.Tonight`}*
Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
@@ -22,4 +23,3 @@ Indicate that the latest version should be marked as skipped. The \<Release\> en
<Skip />
</Collapsible>

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `download` *{`*operations.Download`}*
Indicate that you want to start download any updates found.
@@ -13,4 +14,3 @@ Indicate that you want to start download any updates found.
<Download />
</Collapsible>

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `request` *{`operations.GetTimelineRequest`}*
The request object to use for the request.
@@ -13,4 +14,3 @@ The request object to use for the request.
<GetTimelineRequest />
</Collapsible>

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `request` *{`operations.StartUniversalTranscodeRequest`}*
The request object to use for the request.
@@ -13,4 +14,3 @@ The request object to use for the request.
<StartUniversalTranscodeRequest />
</Collapsible>

View File

@@ -10,4 +10,3 @@ the name of the task to be started.
<TaskName />
</Collapsible>

View File

@@ -10,4 +10,3 @@ The name of the task to be started.
<PathParamTaskName />
</Collapsible>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -10,4 +10,3 @@ The request object to use for the request.
<CreatePlaylistRequest />
</Collapsible>

View File

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

View File

@@ -19,4 +19,3 @@ type of playlists to return (default is all).
<QueryParamSmart />
</Collapsible>

View File

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

View File

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

View File

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

View File

@@ -19,4 +19,3 @@ import Labels from "/src/lib/labels";
<Scope />
</Collapsible>

View File

@@ -10,4 +10,3 @@ The request object to use for the request.
<GetResizedPhotoRequest />
</Collapsible>

View File

@@ -19,4 +19,3 @@ Indicate that the latest version should be marked as skipped. The \<Release\> en
<Skip />
</Collapsible>

View File

@@ -10,4 +10,3 @@ Indicate that you want to start download any updates found.
<Download />
</Collapsible>

View File

@@ -10,4 +10,3 @@ The request object to use for the request.
<GetTimelineRequest />
</Collapsible>

View File

@@ -10,4 +10,3 @@ The request object to use for the request.
<StartUniversalTranscodeRequest />
</Collapsible>

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `activityUUID`: *{`string`}*
The UUID of the activity to cancel.
---
##### `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.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `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.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `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.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `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.

View File

@@ -13,6 +13,7 @@ the name of the task to be started.
---
##### `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.

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `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.

View File

@@ -13,6 +13,7 @@ The name of the task to be started.
---
##### `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.

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `count?`: *{`number`}*
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).
@@ -16,6 +17,7 @@ Only return hubs which are "transient", meaning those which are prone to changin
---
##### `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.

Some files were not shown because too many files have changed in this diff Show More