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 lockVersion: 2.0.0
id: 7fc33f51-d778-40ef-b094-90972c025d39 id: 7fc33f51-d778-40ef-b094-90972c025d39
management: management:
docChecksum: 34d22936f2456c2c461abdfc773e3fc4 docChecksum: d7e0ebb6913e00a62d90ea05f2e5542d
docVersion: 0.0.3 docVersion: 0.0.3
speakeasyVersion: internal speakeasyVersion: internal
generationVersion: 2.235.3 generationVersion: 2.237.2
releaseVersion: 0.1.0 releaseVersion: 0.1.1
configChecksum: 96b7a3b4b875dd83be35e7433e294291 configChecksum: 0c20dc849e2f416cfc75b0f5279fd965
published: true published: true
features: features:
docs: docs:
constsAndDefaults: 0.1.0 constsAndDefaults: 0.1.0
core: 1.24.1 core: 1.24.2
flattening: 0.1.0 flattening: 0.1.0
globalSecurity: 0.1.1 globalSecurity: 0.1.1
globalServerURLs: 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/go.mdx
- content/types/models/operations/get_latest_library_items_response/python.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_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/go.mdx
- content/types/models/operations/get_libraries_response/python.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/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/go.mdx
- content/types/models/operations/get_library_hubs_request/python.mdx - content/types/models/operations/get_library_hubs_request/python.mdx
- content/types/models/operations/get_library_hubs_request/typescript.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/go.mdx
- content/types/models/operations/level/python.mdx - content/types/models/operations/level/python.mdx
- content/types/models/operations/level/typescript.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/go.mdx
- content/types/models/operations/log_line_request/python.mdx - content/types/models/operations/log_line_request/python.mdx
- content/types/models/operations/log_line_request/typescript.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_body/curl.mdx
- content/types/operations/get_recently_added_response/curl.mdx - content/types/operations/get_recently_added_response/curl.mdx
- content/types/operations/get_libraries_errors/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_body/curl.mdx
- content/types/operations/get_libraries_response/curl.mdx - content/types/operations/get_libraries_response/curl.mdx
- content/types/operations/include_details/curl.mdx - content/types/operations/include_details/curl.mdx

View File

@@ -23,3 +23,9 @@ Based on:
Based on: Based on:
- OpenAPI Doc 0.0.3 - OpenAPI Doc 0.0.3
- Speakeasy CLI 1.142.3 (2.235.3) https://github.com/speakeasy-api/speakeasy - 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 /> <TaskName />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

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

View File

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

View File

@@ -3,6 +3,7 @@
This is the path to the local file, must be prefixed by `file://` This is the path to the local file, must be prefixed by `file://`
<br/> <br/>
**Example:** `file://C:\Image.png&type=13` **Example:** `file://C:\Image.png&type=13`
--- ---
##### `type` _number (optional)_ ##### `type` _number (optional)_
Item type Item type

View File

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

View File

@@ -1,4 +1,5 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
import GetLibrariesMediaContainer from "/content/types/operations/get_libraries_media_container/curl.mdx"
import Collapsible from "/src/components/Collapsible"; import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels"; import Labels from "/src/lib/labels";
@@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'> <TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */} {/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}> <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> </Tab>
{/* prettier-ignore */} {/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}> <Tab title={<StatusCode code={"400"} />}>

View File

@@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/library/sections \
```json Example Response ```json Example Response
{ {
"errors": [ "MediaContainer": {
{ "size": 5,
"code": 1001, "allowSync": false,
"message": "User could not be authenticated", "title1": "Plex Library",
"status": 401 "Directory": []
} }
]
} }
``` ```
</CH.Code> </CH.Code>

View File

@@ -7,6 +7,7 @@ import Labels from "/src/lib/labels";
the Id of the library to query the Id of the library to query
<br/> <br/>
**Example:** `1000` **Example:** `1000`
--- ---
##### `includeDetails` _enumeration (optional)_ ##### `includeDetails` _enumeration (optional)_
Whether or not to include details for a section (types, filters, and sorts). 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 /> <IncludeDetails />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -13,6 +13,7 @@ The GUID of each playlist is based on the filename.
<br/> <br/>
**Example:** `/home/barkley/playlist.m3u` **Example:** `/home/barkley/playlist.m3u`
--- ---
##### `force` _enumeration_ ##### `force` _enumeration_
force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. 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 /> <Force />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `activityUUID` *{`string`}* ##### `activityUUID` *{`string`}*
The UUID of the activity to cancel. 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `taskName` *{`operations.TaskName`}* ##### `taskName` *{`operations.TaskName`}*
the name of the task to be started. the name of the task to be started.
@@ -13,4 +14,3 @@ the name of the task to be started.
<TaskName /> <TaskName />
</Collapsible> </Collapsible>

View File

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

View File

@@ -5,9 +5,11 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `count` *{`*float64`}* ##### `count` *{`*float64`}*
The number of items to return with each hub. The number of items to return with each hub.
--- ---
##### `onlyTransient` *{`*operations.OnlyTransient`}* ##### `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). 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 /> <OnlyTransient />
</Collapsible> </Collapsible>

View File

@@ -5,12 +5,15 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to query the Id of the library to query
--- ---
##### `count` *{`*float64`}* ##### `count` *{`*float64`}*
The number of items to return with each hub. The number of items to return with each hub.
--- ---
##### `onlyTransient` *{`*operations.QueryParamOnlyTransient`}* ##### `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). 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 /> <QueryParamOnlyTransient />
</Collapsible> </Collapsible>

View File

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

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type_` *{`float64`}* ##### `type_` *{`float64`}*
item type item type
--- ---
##### `filter` *{`*string`}* ##### `filter` *{`*string`}*
the filter parameter the filter parameter

View File

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

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type_` *{`float64`}* ##### `type_` *{`float64`}*
item type item type
--- ---
##### `filter` *{`*string`}* ##### `filter` *{`*string`}*
the filter parameter the filter parameter

View File

@@ -8,7 +8,6 @@ import(
"github.com/LukeHagar/plexgo" "github.com/LukeHagar/plexgo"
"context" "context"
"log" "log"
"net/http"
) )
func main() { func main() {
@@ -22,7 +21,7 @@ func main() {
log.Fatal(err) log.Fatal(err)
} }
if res.StatusCode == http.StatusOK { if res.Object != nil {
// handle response // handle response
} }
} }
@@ -31,13 +30,12 @@ func main() {
```json Example Response ```json Example Response
{ {
"errors": [ "MediaContainer": {
{ "size": 5,
"code": 1001, "allowSync": false,
"message": "User could not be authenticated", "title1": "Plex Library",
"status": 401 "Directory": []
} }
]
} }
``` ```
</CH.Code> </CH.Code>

View File

@@ -5,11 +5,13 @@ import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to query the Id of the library to query
<br/> <br/>
**Example:** `1000` **Example:** `1000`
--- ---
##### `includeDetails` *{`*operations.IncludeDetails`}* ##### `includeDetails` *{`*operations.IncludeDetails`}*
Whether or not to include details for a section (types, filters, and sorts). 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 /> <IncludeDetails />
</Collapsible> </Collapsible>

View File

@@ -1,12 +1,15 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type_` *{`*float64`}* ##### `type_` *{`*float64`}*
item type item type
--- ---
##### `filter` *{`*string`}* ##### `filter` *{`*string`}*
the filter parameter the filter parameter

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sectionID` *{`float64`}* ##### `sectionID` *{`float64`}*
the Id of the library to refresh 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `level` *{`operations.Level`}* ##### `level` *{`operations.Level`}*
An integer log level to write to the PMS log with. 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`}* ##### `message` *{`string`}*
The text of the message to write to the log. The text of the message to write to the log.
--- ---
##### `source` *{`string`}* ##### `source` *{`string`}*
a string indicating the source of the message. a string indicating the source of the message.

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `playlistID` *{`float64`}* ##### `playlistID` *{`float64`}*
the ID of the playlist 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `request` *{`operations.CreatePlaylistRequest`}* ##### `request` *{`operations.CreatePlaylistRequest`}*
The request object to use for the request. The request object to use for the request.
@@ -13,4 +14,3 @@ The request object to use for the request.
<CreatePlaylistRequest /> <CreatePlaylistRequest />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `playlistID` *{`float64`}* ##### `playlistID` *{`float64`}*
the ID of the playlist the ID of the playlist
--- ---
##### `type_` *{`float64`}* ##### `type_` *{`float64`}*
the metadata type of the item to return 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `playlistType` *{`*operations.PlaylistType`}* ##### `playlistType` *{`*operations.PlaylistType`}*
limit to a type of playlist. limit to a type of playlist.
@@ -22,4 +23,3 @@ type of playlists to return (default is all).
<QueryParamSmart /> <QueryParamSmart />
</Collapsible> </Collapsible>

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `playlistID` *{`float64`}* ##### `playlistID` *{`float64`}*
the ID of the playlist 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `path` *{`string`}* ##### `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. 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/> <br/>
**Example:** `/home/barkley/playlist.m3u` **Example:** `/home/barkley/playlist.m3u`
--- ---
##### `force` *{`operations.Force`}* ##### `force` *{`operations.Force`}*
force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. 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 /> <Force />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `source` *{`string`}* ##### `source` *{`string`}*
The source identifier with an included prefix. 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `type_` *{`operations.QueryParamType`}* ##### `type_` *{`operations.QueryParamType`}*
`delegation` \- This is the only supported `type` parameter. `delegation` \- This is the only supported `type` parameter.
@@ -22,4 +23,3 @@ The context to use for the request.
<Scope /> <Scope />
</Collapsible> </Collapsible>

View File

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

View File

@@ -1,6 +1,7 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `sessionKey` *{`string`}* ##### `sessionKey` *{`string`}*
the Key of the transcode session to stop 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) ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request. The context to use for the request.
--- ---
##### `tonight` *{`*operations.Tonight`}* ##### `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 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 /> <Skip />
</Collapsible> </Collapsible>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -5,6 +5,7 @@ import Labels from "/src/lib/labels";
##### `count` *{`Optional[float]`}* ##### `count` *{`Optional[float]`}*
The number of items to return with each hub. The number of items to return with each hub.
--- ---
##### `only_transient` *{`Optional[operations.OnlyTransient]`}* ##### `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). 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 /> <OnlyTransient />
</Collapsible> </Collapsible>

View File

@@ -5,9 +5,11 @@ import Labels from "/src/lib/labels";
##### `section_id` *{`float`}* ##### `section_id` *{`float`}*
the Id of the library to query the Id of the library to query
--- ---
##### `count` *{`Optional[float]`}* ##### `count` *{`Optional[float]`}*
The number of items to return with each hub. The number of items to return with each hub.
--- ---
##### `only_transient` *{`Optional[operations.QueryParamOnlyTransient]`}* ##### `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). 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 /> <QueryParamOnlyTransient />
</Collapsible> </Collapsible>

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `section_id` *{`float`}* ##### `section_id` *{`float`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type` *{`float`}* ##### `type` *{`float`}*
item type item type
--- ---
##### `filter_` *{`Optional[str]`}* ##### `filter_` *{`Optional[str]`}*
the filter parameter the filter parameter

View File

@@ -3,6 +3,7 @@
This is the path to the local file, must be prefixed by `file://` This is the path to the local file, must be prefixed by `file://`
<br/> <br/>
**Example:** `file://C:\Image.png&type=13` **Example:** `file://C:\Image.png&type=13`
--- ---
##### `type` *{`Optional[float]`}* ##### `type` *{`Optional[float]`}*
Item type Item type

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `section_id` *{`float`}* ##### `section_id` *{`float`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type` *{`float`}* ##### `type` *{`float`}*
item type item type
--- ---
##### `filter_` *{`Optional[str]`}* ##### `filter_` *{`Optional[str]`}*
the filter parameter the filter parameter

View File

@@ -10,7 +10,7 @@ s = plex_api.PlexAPI(
res = s.library.get_libraries() res = s.library.get_libraries()
if res.status_code == 200: if res.object is not None:
# handle response # handle response
pass pass
``` ```
@@ -18,13 +18,12 @@ if res.status_code == 200:
```json Example Response ```json Example Response
{ {
"errors": [ "MediaContainer": {
{ "size": 5,
"code": 1001, "allowSync": false,
"message": "User could not be authenticated", "title1": "Plex Library",
"status": 401 "Directory": []
} }
]
} }
``` ```
</CH.Code> </CH.Code>

View File

@@ -7,6 +7,7 @@ import Labels from "/src/lib/labels";
the Id of the library to query the Id of the library to query
<br/> <br/>
**Example:** `1000` **Example:** `1000`
--- ---
##### `include_details` *{`Optional[operations.IncludeDetails]`}* ##### `include_details` *{`Optional[operations.IncludeDetails]`}*
Whether or not to include details for a section (types, filters, and sorts). 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 /> <IncludeDetails />
</Collapsible> </Collapsible>

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `section_id` *{`float`}* ##### `section_id` *{`float`}*
the Id of the library to query the Id of the library to query
--- ---
##### `type` *{`Optional[float]`}* ##### `type` *{`Optional[float]`}*
item type item type
--- ---
##### `filter_` *{`Optional[str]`}* ##### `filter_` *{`Optional[str]`}*
the filter parameter the filter parameter

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -13,6 +13,7 @@ The GUID of each playlist is based on the filename.
<br/> <br/>
**Example:** `/home/barkley/playlist.m3u` **Example:** `/home/barkley/playlist.m3u`
--- ---
##### `force` *{`operations.Force`}* ##### `force` *{`operations.Force`}*
force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. 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 /> <Force />
</Collapsible> </Collapsible>

View File

@@ -3,9 +3,11 @@
The query term The query term
<br/> <br/>
**Example:** `arnold` **Example:** `arnold`
--- ---
##### `section_id` *{`Optional[float]`}* ##### `section_id` *{`Optional[float]`}*
This gives context to the search, and can result in re\-ordering of search result hubs This gives context to the search, and can result in re\-ordering of search result hubs
--- ---
##### `limit` *{`Optional[float]`}* ##### `limit` *{`Optional[float]`}*
The number of items to return per hub The number of items to return per hub

View File

@@ -3,9 +3,11 @@
The query term The query term
<br/> <br/>
**Example:** `dead+poop` **Example:** `dead+poop`
--- ---
##### `section_id` *{`Optional[float]`}* ##### `section_id` *{`Optional[float]`}*
This gives context to the search, and can result in re\-ordering of search result hubs This gives context to the search, and can result in re\-ordering of search result hubs
--- ---
##### `limit` *{`Optional[float]`}* ##### `limit` *{`Optional[float]`}*
The number of items to return per hub The number of items to return per hub

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,9 +1,11 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `activityUUID`: *{`string`}* ##### `activityUUID`: *{`string`}*
The UUID of the activity to cancel. The UUID of the activity to cancel.
--- ---
##### `options?`: *{`RequestOptions`}* ##### `options?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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 */} {/* Autogenerated DO NOT EDIT */}
##### `options?`: *{`RequestOptions`}* ##### `options?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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 */} {/* Autogenerated DO NOT EDIT */}
##### `options?`: *{`RequestOptions`}* ##### `options?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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 */} {/* Autogenerated DO NOT EDIT */}
##### `options?`: *{`RequestOptions`}* ##### `options?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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 */} {/* Autogenerated DO NOT EDIT */}
##### `options?`: *{`RequestOptions`}* ##### `options?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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`}* ##### `count?`: *{`number`}*
The number of items to return with each hub. The number of items to return with each hub.
--- ---
##### `onlyTransient?`: *{`operations.OnlyTransient`}* ##### `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). 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?`: *{`RequestOptions`}*
Options for making HTTP requests. Options for making HTTP requests.
--- ---
##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) ##### `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. 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