mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
c65c9e0cae | ||
|
|
95df2396e7 | ||
|
|
f52d81d1f6 | ||
|
|
d83bd96c5f | ||
|
|
2289036c2b | ||
|
|
a7eedd3598 | ||
|
|
e579b8d23b | ||
|
|
fd429e38e0 | ||
|
|
2b4a59f67f | ||
|
|
6268a854c1 | ||
|
|
d061e9c253 | ||
|
|
fcfb68eec7 | ||
|
|
37dabea51a | ||
|
|
f47e4b689b | ||
|
|
04130d41d4 | ||
|
|
393db01a6c | ||
|
|
41621a4bbd | ||
|
|
05f0b1a99a | ||
|
|
0ce63f1ceb |
2
.github/workflows/sdk_generation.yaml
vendored
2
.github/workflows/sdk_generation.yaml
vendored
@@ -21,7 +21,7 @@ jobs:
|
|||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
with:
|
with:
|
||||||
force: ${{ github.event.inputs.force }}
|
force: ${{ github.event.inputs.force }}
|
||||||
mode: pr
|
mode: direct
|
||||||
set_version: ${{ github.event.inputs.set_version }}
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
speakeasy_version: latest
|
speakeasy_version: latest
|
||||||
secrets:
|
secrets:
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
go:
|
go:
|
||||||
version: 0.11.1
|
version: 0.13.0
|
||||||
additionalDependencies: {}
|
additionalDependencies: {}
|
||||||
allowUnknownFieldsInWeakUnions: false
|
allowUnknownFieldsInWeakUnions: false
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
|||||||
@@ -1,33 +1,39 @@
|
|||||||
speakeasyVersion: 1.393.1
|
speakeasyVersion: 1.402.14
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
sourceRevisionDigest: sha256:92a2a2049bfbf67bea601a6b1b77d274e83a2d3b6968a0bc02dc290b21c7689d
|
||||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
|
||||||
|
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
targets:
|
targets:
|
||||||
plexgo:
|
plexgo:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
|
||||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
|
||||||
codeSamplesNamespace: code-samples-go-plexgo
|
codeSamplesNamespace: code-samples-go-plexgo
|
||||||
codeSamplesRevisionDigest: sha256:367216afa9fb24c1dc1897cadc3feb86418148d80ebe2f8263ec65dbba5f2cee
|
codeSamplesRevisionDigest: sha256:77cf87f3a1619a7cf598f60cf04a2f82dd0809dd1d449c2a1f67a63729f5726a
|
||||||
outLocation: /github/workspace/repo
|
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexgo:
|
plexgo:
|
||||||
target: go
|
target: go
|
||||||
source: my-source
|
source: plexapi
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-go-plexgo
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-go-plexgo
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
targets:
|
targets:
|
||||||
plexgo:
|
plexgo:
|
||||||
target: go
|
target: go
|
||||||
source: my-source
|
source: plexapi
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-go-plexgo
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-go-plexgo
|
||||||
|
|||||||
205
README.md
205
README.md
@@ -54,7 +54,11 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -73,36 +77,21 @@ func main() {
|
|||||||
<!-- Start Available Resources and Operations [operations] -->
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
## Available Resources and Operations
|
## Available Resources and Operations
|
||||||
|
|
||||||
### [Server](docs/sdks/server/README.md)
|
<details open>
|
||||||
|
<summary>Available methods</summary>
|
||||||
* [GetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
|
||||||
* [GetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
|
||||||
* [GetAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
|
||||||
* [GetDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
|
||||||
* [GetServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
|
||||||
* [GetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
|
||||||
* [GetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
|
||||||
* [GetMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
|
||||||
* [GetServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
|
||||||
|
|
||||||
### [Media](docs/sdks/media/README.md)
|
|
||||||
|
|
||||||
* [MarkPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
|
||||||
* [MarkUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
|
||||||
* [UpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
|
||||||
* [GetBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
|
||||||
* [GetThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
|
||||||
|
|
||||||
### [Video](docs/sdks/video/README.md)
|
|
||||||
|
|
||||||
* [GetTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
|
||||||
* [StartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
|
||||||
|
|
||||||
### [Activities](docs/sdks/activities/README.md)
|
### [Activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
* [GetServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
* [GetServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||||
* [CancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
* [CancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||||
|
|
||||||
|
### [Authentication](docs/sdks/authentication/README.md)
|
||||||
|
|
||||||
|
* [GetTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
|
||||||
|
* [GetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||||
|
* [GetTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||||
|
* [PostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||||
|
|
||||||
### [Butler](docs/sdks/butler/README.md)
|
### [Butler](docs/sdks/butler/README.md)
|
||||||
|
|
||||||
* [GetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
* [GetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||||
@@ -111,31 +100,16 @@ func main() {
|
|||||||
* [StartTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
* [StartTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||||
* [StopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
* [StopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||||
|
|
||||||
### [Plex](docs/sdks/plex/README.md)
|
|
||||||
|
|
||||||
* [GetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
|
||||||
* [GetUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
|
||||||
* [GetGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
|
||||||
* [GetHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
|
||||||
* [GetServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
|
||||||
* [GetPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
|
||||||
* [GetTokenByPinID](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
|
||||||
|
|
||||||
### [Hubs](docs/sdks/hubs/README.md)
|
### [Hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [GetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [GetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
|
* [GetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||||
* [GetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
* [GetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
### [Search](docs/sdks/search/README.md)
|
|
||||||
|
|
||||||
* [PerformSearch](docs/sdks/search/README.md#performsearch) - Perform a search
|
|
||||||
* [PerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
|
||||||
* [GetSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
|
||||||
|
|
||||||
### [Library](docs/sdks/library/README.md)
|
### [Library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [GetFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
* [GetFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
* [GetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
* [GetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||||
* [GetAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
* [GetAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
* [GetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [GetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [DeleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [DeleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
@@ -147,16 +121,20 @@ func main() {
|
|||||||
* [GetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [GetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [GetOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [GetOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
|
|
||||||
### [Watchlist](docs/sdks/watchlist/README.md)
|
|
||||||
|
|
||||||
* [GetWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
|
||||||
|
|
||||||
### [Log](docs/sdks/log/README.md)
|
### [Log](docs/sdks/log/README.md)
|
||||||
|
|
||||||
* [LogLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
* [LogLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
* [LogMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
* [LogMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
* [EnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
* [EnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [Media](docs/sdks/media/README.md)
|
||||||
|
|
||||||
|
* [MarkPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||||
|
* [MarkUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
|
* [UpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||||
|
* [GetBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||||
|
* [GetThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||||
|
|
||||||
### [Playlists](docs/sdks/playlists/README.md)
|
### [Playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
* [CreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
* [CreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
@@ -169,18 +147,34 @@ func main() {
|
|||||||
* [AddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
* [AddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||||
* [UploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
* [UploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||||
|
|
||||||
### [Authentication](docs/sdks/authentication/README.md)
|
### [Plex](docs/sdks/plex/README.md)
|
||||||
|
|
||||||
* [GetTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token.
|
* [GetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||||
* [GetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
* [GetUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||||
* [GetUserDetails](docs/sdks/authentication/README.md#getuserdetails) - Get User Data By Token
|
* [GetGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||||
* [PostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
* [GetHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||||
|
* [GetServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||||
|
* [GetPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||||
|
* [GetTokenByPinID](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||||
|
|
||||||
### [Statistics](docs/sdks/statistics/README.md)
|
|
||||||
|
|
||||||
* [GetStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
### [Search](docs/sdks/search/README.md)
|
||||||
* [GetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
|
||||||
* [GetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
* [PerformSearch](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||||
|
* [PerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||||
|
* [GetSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||||
|
|
||||||
|
### [Server](docs/sdks/server/README.md)
|
||||||
|
|
||||||
|
* [GetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||||
|
* [GetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
|
* [GetAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
|
* [GetDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||||
|
* [GetServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||||
|
* [GetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||||
|
* [GetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||||
|
* [GetMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||||
|
* [GetServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||||
|
|
||||||
### [Sessions](docs/sdks/sessions/README.md)
|
### [Sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
@@ -189,11 +183,28 @@ func main() {
|
|||||||
* [GetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
* [GetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||||
* [StopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
* [StopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||||
|
|
||||||
|
### [Statistics](docs/sdks/statistics/README.md)
|
||||||
|
|
||||||
|
* [GetStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
||||||
|
* [GetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
||||||
|
* [GetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
||||||
|
|
||||||
### [Updater](docs/sdks/updater/README.md)
|
### [Updater](docs/sdks/updater/README.md)
|
||||||
|
|
||||||
* [GetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
* [GetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
* [CheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [CheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [ApplyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [ApplyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [Video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [GetTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
* [StartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
|
||||||
|
### [Watchlist](docs/sdks/watchlist/README.md)
|
||||||
|
|
||||||
|
* [GetWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
|
|
||||||
|
</details>
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
<!-- Start Retries [retries] -->
|
<!-- Start Retries [retries] -->
|
||||||
@@ -216,7 +227,11 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -266,7 +281,11 @@ func main() {
|
|||||||
RetryConnectionErrors: false,
|
RetryConnectionErrors: false,
|
||||||
}),
|
}),
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -287,11 +306,11 @@ func main() {
|
|||||||
|
|
||||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
|
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
|
||||||
|
|
||||||
| Error Object | Status Code | Content Type |
|
| Error Object | Status Code | Content Type |
|
||||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||||
| sdkerrors.GetServerCapabilitiesResponseBody | 400 | application/json |
|
| sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||||
| sdkerrors.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
| sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
@@ -309,20 +328,24 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
res, err := s.Server.GetServerCapabilities(ctx)
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
||||||
var e *sdkerrors.GetServerCapabilitiesResponseBody
|
var e *sdkerrors.GetServerCapabilitiesBadRequest
|
||||||
if errors.As(err, &e) {
|
if errors.As(err, &e) {
|
||||||
// handle error
|
// handle error
|
||||||
log.Fatal(e.Error())
|
log.Fatal(e.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
var e *sdkerrors.GetServerCapabilitiesServerResponseBody
|
var e *sdkerrors.GetServerCapabilitiesUnauthorized
|
||||||
if errors.As(err, &e) {
|
if errors.As(err, &e) {
|
||||||
// handle error
|
// handle error
|
||||||
log.Fatal(e.Error())
|
log.Fatal(e.Error())
|
||||||
@@ -365,7 +388,11 @@ func main() {
|
|||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithServerIndex(0),
|
plexgo.WithServerIndex(0),
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -403,7 +430,11 @@ func main() {
|
|||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
|
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -434,7 +465,11 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -503,7 +538,11 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
@@ -548,21 +587,25 @@ d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on
|
|||||||
<!-- Start Global Parameters [global-parameters] -->
|
<!-- Start Global Parameters [global-parameters] -->
|
||||||
## Global Parameters
|
## Global Parameters
|
||||||
|
|
||||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
||||||
|
|
||||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
### Available Globals
|
||||||
|
|
||||||
The following global parameter is available.
|
The following global parameters are available.
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
| Name | Type | Required | Description |
|
||||||
| ---- | ---- |:--------:| ----------- |
|
| ---- | ---- |:--------:| ----------- |
|
||||||
| XPlexClientIdentifier | string | | The unique identifier for the client application
|
| ClientID | string | | The unique identifier for the client application
|
||||||
This is used to track the client application and its usage
|
This is used to track the client application and its usage
|
||||||
(UUID, serial number, or other number unique per device)
|
(UUID, serial number, or other number unique per device)
|
||||||
|
|
|
|
||||||
|
| ClientName | string | | The ClientName parameter. |
|
||||||
|
| ClientVersion | string | | The ClientVersion parameter. |
|
||||||
|
| ClientPlatform | string | | The ClientPlatform parameter. |
|
||||||
|
| DeviceName | string | | The DeviceName parameter. |
|
||||||
|
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
@@ -579,21 +622,19 @@ import (
|
|||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
res, err := s.Plex.GetServerResources(ctx, operations.GetServerResourcesRequest{
|
res, err := s.Plex.GetPin(ctx, operations.GetPinRequest{})
|
||||||
XPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
|
||||||
IncludeHTTPS: operations.IncludeHTTPSOne.ToPointer(),
|
|
||||||
IncludeRelay: operations.IncludeRelayOne.ToPointer(),
|
|
||||||
IncludeIPv6: operations.IncludeIPv6One.ToPointer(),
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
if res.PlexDevices != nil {
|
if res.AuthPinContainer != nil {
|
||||||
// handle response
|
// handle response
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
160
RELEASES.md
160
RELEASES.md
@@ -763,3 +763,163 @@ Based on:
|
|||||||
- [go v0.11.1] .
|
- [go v0.11.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Go v0.11.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.1 - .
|
- [Go v0.11.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.1 - .
|
||||||
|
|
||||||
|
## 2024-09-09 20:35:17
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.393.2 (2.413.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.2] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.2] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.2 - .
|
||||||
|
|
||||||
|
## 2024-09-10 00:08:55
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.394.0 (2.413.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.3] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.3] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.3 - .
|
||||||
|
|
||||||
|
## 2024-09-11 00:08:50
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.4] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.4] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.4 - .
|
||||||
|
|
||||||
|
## 2024-09-12 00:08:45
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.2 (2.415.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.5] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.5] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.5 - .
|
||||||
|
|
||||||
|
## 2024-09-13 00:08:56
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.6] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.6] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.6 - .
|
||||||
|
|
||||||
|
## 2024-09-14 00:08:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.7] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.7] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.7 - .
|
||||||
|
|
||||||
|
## 2024-09-15 00:09:40
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.8] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.8] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.8 - .
|
||||||
|
|
||||||
|
## 2024-09-16 00:09:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.396.9 (2.415.7) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.9] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.9] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.9 - .
|
||||||
|
|
||||||
|
## 2024-09-16 18:35:29
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.10] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.10] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.10 - .
|
||||||
|
|
||||||
|
## 2024-09-18 03:01:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.399.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.11] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.11] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.11 - .
|
||||||
|
|
||||||
|
## 2024-09-18 14:09:58
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.399.1 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.12] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.12] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.12 - .
|
||||||
|
|
||||||
|
## 2024-09-18 15:01:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.13] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.13] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.13 - .
|
||||||
|
|
||||||
|
## 2024-09-19 00:08:52
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.11.14] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.11.14] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.14 - .
|
||||||
|
|
||||||
|
## 2024-09-21 00:08:46
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.12.0] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.12.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.12.0 - .
|
||||||
|
|
||||||
|
## 2024-09-22 00:09:45
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.12.1] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.12.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.12.1 - .
|
||||||
|
|
||||||
|
## 2024-09-26 00:09:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.13.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.13.0 - .
|
||||||
6
USAGE.md
6
USAGE.md
@@ -11,7 +11,11 @@ import (
|
|||||||
func main() {
|
func main() {
|
||||||
s := plexgo.New(
|
s := plexgo.New(
|
||||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
|
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||||
|
plexgo.WithClientName("Plex Web"),
|
||||||
|
plexgo.WithClientVersion("4.133.0"),
|
||||||
|
plexgo.WithClientPlatform("Chrome"),
|
||||||
|
plexgo.WithDeviceName("Linux"),
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|||||||
@@ -215,7 +215,7 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetServerActivitiesResponseBody
|
var out sdkerrors.GetServerActivitiesBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -238,7 +238,7 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetServerActivitiesActivitiesResponseBody
|
var out sdkerrors.GetServerActivitiesUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -440,7 +440,7 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.CancelServerActivitiesResponseBody
|
var out sdkerrors.CancelServerActivitiesBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -463,7 +463,7 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.CancelServerActivitiesActivitiesResponseBody
|
var out sdkerrors.CancelServerActivitiesUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ func newAuthentication(sdkConfig sdkConfiguration) *Authentication {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetTransientToken - Get a Transient Token.
|
// GetTransientToken - Get a Transient Token
|
||||||
// This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
// This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
||||||
func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations.GetTransientTokenQueryParamType, scope operations.Scope, opts ...operations.Option) (*operations.GetTransientTokenResponse, error) {
|
func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations.GetTransientTokenQueryParamType, scope operations.Scope, opts ...operations.Option) (*operations.GetTransientTokenResponse, error) {
|
||||||
hookCtx := hooks.HookContext{
|
hookCtx := hooks.HookContext{
|
||||||
@@ -197,7 +197,7 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetTransientTokenResponseBody
|
var out sdkerrors.GetTransientTokenBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -220,7 +220,7 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetTransientTokenAuthenticationResponseBody
|
var out sdkerrors.GetTransientTokenUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -427,7 +427,7 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetSourceConnectionInformationResponseBody
|
var out sdkerrors.GetSourceConnectionInformationBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -450,7 +450,7 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetSourceConnectionInformationAuthenticationResponseBody
|
var out sdkerrors.GetSourceConnectionInformationUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -487,20 +487,16 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetUserDetails - Get User Data By Token
|
// GetTokenDetails - Get Token Details
|
||||||
// Get the User data from the provided X-Plex-Token
|
// Get the User data from the provided X-Plex-Token
|
||||||
func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string, opts ...operations.Option) (*operations.GetUserDetailsResponse, error) {
|
func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations.Option) (*operations.GetTokenDetailsResponse, error) {
|
||||||
hookCtx := hooks.HookContext{
|
hookCtx := hooks.HookContext{
|
||||||
Context: ctx,
|
Context: ctx,
|
||||||
OperationID: "getUserDetails",
|
OperationID: "getTokenDetails",
|
||||||
OAuth2Scopes: []string{},
|
OAuth2Scopes: []string{},
|
||||||
SecuritySource: s.sdkConfiguration.Security,
|
SecuritySource: s.sdkConfiguration.Security,
|
||||||
}
|
}
|
||||||
|
|
||||||
request := operations.GetUserDetailsRequest{
|
|
||||||
XPlexToken: xPlexToken,
|
|
||||||
}
|
|
||||||
|
|
||||||
o := operations.Options{}
|
o := operations.Options{}
|
||||||
supportedOptions := []string{
|
supportedOptions := []string{
|
||||||
operations.SupportedOptionServerURL,
|
operations.SupportedOptionServerURL,
|
||||||
@@ -514,7 +510,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
baseURL := utils.ReplaceParameters(operations.GetUserDetailsServerList[0], map[string]string{})
|
baseURL := utils.ReplaceParameters(operations.GetTokenDetailsServerList[0], map[string]string{})
|
||||||
if o.ServerURL != nil {
|
if o.ServerURL != nil {
|
||||||
baseURL = *o.ServerURL
|
baseURL = *o.ServerURL
|
||||||
}
|
}
|
||||||
@@ -542,10 +538,6 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
req.Header.Set("Accept", "application/json")
|
req.Header.Set("Accept", "application/json")
|
||||||
req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent)
|
req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
if err := utils.PopulateQueryParams(ctx, req, request, nil); err != nil {
|
|
||||||
return nil, fmt.Errorf("error populating query params: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil {
|
if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -635,7 +627,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
res := &operations.GetUserDetailsResponse{
|
res := &operations.GetTokenDetailsResponse{
|
||||||
StatusCode: httpRes.StatusCode,
|
StatusCode: httpRes.StatusCode,
|
||||||
ContentType: httpRes.Header.Get("Content-Type"),
|
ContentType: httpRes.Header.Get("Content-Type"),
|
||||||
RawResponse: httpRes,
|
RawResponse: httpRes,
|
||||||
@@ -660,7 +652,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out operations.GetUserDetailsUserPlexAccount
|
var out operations.GetTokenDetailsUserPlexAccount
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -682,7 +674,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetUserDetailsResponseBody
|
var out sdkerrors.GetTokenDetailsBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -705,7 +697,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetUserDetailsAuthenticationResponseBody
|
var out sdkerrors.GetTokenDetailsUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -744,7 +736,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
|||||||
|
|
||||||
// PostUsersSignInData - Get User Sign In Data
|
// PostUsersSignInData - Get User Sign In Data
|
||||||
// Sign in user with username and password and return user data with Plex authentication token
|
// Sign in user with username and password and return user data with Plex authentication token
|
||||||
func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIdentifier *string, requestBody *operations.PostUsersSignInDataRequestBody, opts ...operations.Option) (*operations.PostUsersSignInDataResponse, error) {
|
func (s *Authentication) PostUsersSignInData(ctx context.Context, request operations.PostUsersSignInDataRequest, opts ...operations.Option) (*operations.PostUsersSignInDataResponse, error) {
|
||||||
hookCtx := hooks.HookContext{
|
hookCtx := hooks.HookContext{
|
||||||
Context: ctx,
|
Context: ctx,
|
||||||
OperationID: "post-users-sign-in-data",
|
OperationID: "post-users-sign-in-data",
|
||||||
@@ -752,13 +744,12 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
|||||||
SecuritySource: nil,
|
SecuritySource: nil,
|
||||||
}
|
}
|
||||||
|
|
||||||
request := operations.PostUsersSignInDataRequest{
|
|
||||||
XPlexClientIdentifier: xPlexClientIdentifier,
|
|
||||||
RequestBody: requestBody,
|
|
||||||
}
|
|
||||||
|
|
||||||
globals := operations.PostUsersSignInDataGlobals{
|
globals := operations.PostUsersSignInDataGlobals{
|
||||||
XPlexClientIdentifier: s.sdkConfiguration.Globals.XPlexClientIdentifier,
|
ClientID: s.sdkConfiguration.Globals.ClientID,
|
||||||
|
ClientName: s.sdkConfiguration.Globals.ClientName,
|
||||||
|
DeviceName: s.sdkConfiguration.Globals.DeviceName,
|
||||||
|
ClientVersion: s.sdkConfiguration.Globals.ClientVersion,
|
||||||
|
ClientPlatform: s.sdkConfiguration.Globals.ClientPlatform,
|
||||||
}
|
}
|
||||||
|
|
||||||
o := operations.Options{}
|
o := operations.Options{}
|
||||||
@@ -944,7 +935,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.PostUsersSignInDataResponseBody
|
var out sdkerrors.PostUsersSignInDataBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -967,7 +958,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.PostUsersSignInDataAuthenticationResponseBody
|
var out sdkerrors.PostUsersSignInDataUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
20
butler.go
20
butler.go
@@ -209,7 +209,7 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetButlerTasksResponseBody
|
var out sdkerrors.GetButlerTasksBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -232,7 +232,7 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.GetButlerTasksButlerResponseBody
|
var out sdkerrors.GetButlerTasksUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -434,7 +434,7 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StartAllTasksResponseBody
|
var out sdkerrors.StartAllTasksBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -457,7 +457,7 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StartAllTasksButlerResponseBody
|
var out sdkerrors.StartAllTasksUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -655,7 +655,7 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StopAllTasksResponseBody
|
var out sdkerrors.StopAllTasksBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -678,7 +678,7 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StopAllTasksButlerResponseBody
|
var out sdkerrors.StopAllTasksUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -886,7 +886,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StartTaskResponseBody
|
var out sdkerrors.StartTaskBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -909,7 +909,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StartTaskButlerResponseBody
|
var out sdkerrors.StartTaskUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -1111,7 +1111,7 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StopTaskResponseBody
|
var out sdkerrors.StopTaskBadRequest
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -1134,7 +1134,7 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
var out sdkerrors.StopTaskButlerResponseBody
|
var out sdkerrors.StopTaskUnauthorized
|
||||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
567
codeSamples.yaml
567
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
9
docs/models/operations/action.md
Normal file
9
docs/models/operations/action.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Action
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `ID` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||||
12
docs/models/operations/activedirection.md
Normal file
12
docs/models/operations/activedirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# ActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------- | --------------------------- |
|
||||||
|
| `ActiveDirectionAscending` | asc |
|
||||||
|
| `ActiveDirectionDescending` | desc |
|
||||||
@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------------------------ | ------------------------ |
|
| --------------------------- | --------------------------- |
|
||||||
| `AutoSelectSubtitleZero` | 0 |
|
| `AutoSelectSubtitleDisable` | 0 |
|
||||||
| `AutoSelectSubtitleOne` | 1 |
|
| `AutoSelectSubtitleEnable` | 1 |
|
||||||
8
docs/models/operations/collection.md
Normal file
8
docs/models/operations/collection.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Collection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
@@ -3,12 +3,12 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
| `Protocol` | *string* | :heavy_check_mark: | N/A |
|
| `Protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
|
||||||
| `Address` | *string* | :heavy_check_mark: | N/A |
|
| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
|
||||||
| `Port` | *float64* | :heavy_check_mark: | N/A |
|
| `Port` | *int* | :heavy_check_mark: | The port used for the connection |
|
||||||
| `URI` | *string* | :heavy_check_mark: | N/A |
|
| `URI` | *string* | :heavy_check_mark: | The full URI of the connection |
|
||||||
| `Local` | *bool* | :heavy_check_mark: | N/A |
|
| `Local` | *bool* | :heavy_check_mark: | If the connection is local address |
|
||||||
| `Relay` | *bool* | :heavy_check_mark: | N/A |
|
| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct |
|
||||||
| `IPv6` | *bool* | :heavy_check_mark: | N/A |
|
| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 |
|
||||||
12
docs/models/operations/defaultdirection.md
Normal file
12
docs/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# DefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------- | ---------------------------- |
|
||||||
|
| `DefaultDirectionAscending` | asc |
|
||||||
|
| `DefaultDirectionDescending` | desc |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# DefaultSubtitleAccessibility
|
# DefaultSubtitleAccessibility
|
||||||
|
|
||||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ---------------------------------- | ---------------------------------- |
|
| ------------------------------------- | ------------------------------------- |
|
||||||
| `DefaultSubtitleAccessibilityZero` | 0 |
|
| `DefaultSubtitleAccessibilityDisable` | 0 |
|
||||||
| `DefaultSubtitleAccessibilityOne` | 1 |
|
| `DefaultSubtitleAccessibilityEnable` | 1 |
|
||||||
@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------------------------- | --------------------------- |
|
| ------------------------------ | ------------------------------ |
|
||||||
| `DefaultSubtitleForcedZero` | 0 |
|
| `DefaultSubtitleForcedDisable` | 0 |
|
||||||
| `DefaultSubtitleForcedOne` | 1 |
|
| `DefaultSubtitleForcedEnable` | 1 |
|
||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||||
@@ -3,8 +3,12 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A |
|
| `Key` | **string* | :heavy_minus_sign: | N/A | |
|
||||||
| `Type` | **string* | :heavy_minus_sign: | N/A |
|
| `Type` | *string* | :heavy_check_mark: | N/A | |
|
||||||
| `Directory` | [][operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md) | :heavy_minus_sign: | N/A |
|
| `Flavor` | **string* | :heavy_minus_sign: | N/A | global |
|
||||||
|
| `ScrobbleKey` | **string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||||
|
| `UnscrobbleKey` | **string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||||
|
| `Directory` | [][operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Action` | [][operations.Action](../../models/operations/action.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A | label |
|
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Label |
|
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
| `Type` | **string* | :heavy_minus_sign: | N/A | tag |
|
| `Type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
| `SubType` | **string* | :heavy_minus_sign: | N/A | bitrate |
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
| `Type` | **string* | :heavy_minus_sign: | N/A | resolution |
|
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
| `Operator` | [][operations.Operator](../../models/operations/operator.md) | :heavy_minus_sign: | N/A | |
|
| `Operator` | [][operations.Operator](../../models/operations/operator.md) | :heavy_check_mark: | N/A | |
|
||||||
9
docs/models/operations/flattenseasons.md
Normal file
9
docs/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# FlattenSeasons
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------- | --------------------- |
|
||||||
|
| `FlattenSeasonsFalse` | 0 |
|
||||||
|
| `FlattenSeasonsTrue` | 1 |
|
||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Comedy |
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Adventure |
|
||||||
@@ -13,7 +13,7 @@ Geo location data
|
|||||||
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
||||||
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
| `PostalCode` | *int64* | :heavy_check_mark: | The postal code of the location. | 802 |
|
| `PostalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
||||||
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
||||||
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
|||||||
@@ -5,24 +5,24 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `Composite` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
| `Composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
| `Filters` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `Filters` | *bool* | :heavy_check_mark: | N/A | true |
|
||||||
| `Refreshing` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Refreshing` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A | 1 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `Title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `Agent` | **string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
| `Agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||||
| `Scanner` | **string* | :heavy_minus_sign: | N/A | Plex Movie |
|
| `Scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||||
| `Language` | **string* | :heavy_minus_sign: | N/A | en-US |
|
| `Language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||||
| `UUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `UUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `UpdatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `CreatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `CreatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `ScannedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
| `ScannedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `Content` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `Content` | *bool* | :heavy_check_mark: | N/A | true |
|
||||||
| `Directory` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `Directory` | *bool* | :heavy_check_mark: | N/A | true |
|
||||||
| `ContentChangedAt` | **int* | :heavy_minus_sign: | N/A | 3192854 |
|
| `ContentChangedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `Hidden` | **int* | :heavy_minus_sign: | N/A | 0 |
|
| `Hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
|
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
|
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||||
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
|
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -5,6 +5,6 @@ The libraries available on the Server
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `MediaContainer` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
| `MediaContainer` | [operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -13,7 +13,7 @@ Geo location data
|
|||||||
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
|
||||||
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
| `PostalCode` | *int64* | :heavy_check_mark: | The postal code of the location. | 802 |
|
| `PostalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
|
||||||
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
|
||||||
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
|||||||
11
docs/models/operations/getlibrarydetailsfield.md
Normal file
11
docs/models/operations/getlibrarydetailsfield.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryDetailsField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Label |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A | tag |
|
||||||
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | bitrate |
|
||||||
9
docs/models/operations/getlibrarydetailsfieldtype.md
Normal file
9
docs/models/operations/getlibrarydetailsfieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryDetailsFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A | resolution |
|
||||||
|
| `Operator` | [][operations.GetLibraryDetailsOperator](../../models/operations/getlibrarydetailsoperator.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -19,4 +19,4 @@
|
|||||||
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
| `Directory` | [][operations.GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md) | :heavy_minus_sign: | N/A | |
|
| `Directory` | [][operations.GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Type` | [][operations.GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md) | :heavy_minus_sign: | N/A | |
|
| `Type` | [][operations.GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |
|
| `FieldType` | [][operations.GetLibraryDetailsFieldType](../../models/operations/getlibrarydetailsfieldtype.md) | :heavy_minus_sign: | N/A | |
|
||||||
9
docs/models/operations/getlibrarydetailsoperator.md
Normal file
9
docs/models/operations/getlibrarydetailsoperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryDetailsOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | = |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | is |
|
||||||
13
docs/models/operations/getlibrarydetailssort.md
Normal file
13
docs/models/operations/getlibrarydetailssort.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetLibraryDetailsSort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `DefaultDirection` | **string* | :heavy_minus_sign: | N/A | desc |
|
||||||
|
| `DescKey` | **string* | :heavy_minus_sign: | N/A | random:desc |
|
||||||
|
| `FirstCharacterKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/firstCharacter |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | random |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Randomly |
|
||||||
@@ -10,5 +10,5 @@
|
|||||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `Filter` | [][operations.GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md) | :heavy_minus_sign: | N/A | |
|
| `Filter` | [][operations.GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Sort` | [][operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | N/A | |
|
| `Sort` | [][operations.GetLibraryDetailsSort](../../models/operations/getlibrarydetailssort.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Field` | [][operations.Field](../../models/operations/field.md) | :heavy_minus_sign: | N/A | |
|
| `Field` | [][operations.GetLibraryDetailsField](../../models/operations/getlibrarydetailsfield.md) | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/getlibraryitemsactivedirection.md
Normal file
12
docs/models/operations/getlibraryitemsactivedirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------ | ------------------------------------------ |
|
||||||
|
| `GetLibraryItemsActiveDirectionAscending` | asc |
|
||||||
|
| `GetLibraryItemsActiveDirectionDescending` | desc |
|
||||||
8
docs/models/operations/getlibraryitemscollection.md
Normal file
8
docs/models/operations/getlibraryitemscollection.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsCollection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||||
12
docs/models/operations/getlibraryitemsdefaultdirection.md
Normal file
12
docs/models/operations/getlibraryitemsdefaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------- | ------------------------------------------- |
|
||||||
|
| `GetLibraryItemsDefaultDirectionAscending` | asc |
|
||||||
|
| `GetLibraryItemsDefaultDirectionDescending` | desc |
|
||||||
11
docs/models/operations/getlibraryitemsfield.md
Normal file
11
docs/models/operations/getlibraryitemsfield.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||||
9
docs/models/operations/getlibraryitemsfieldtype.md
Normal file
9
docs/models/operations/getlibraryitemsfieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `Operator` | [][operations.GetLibraryItemsOperator](../../models/operations/getlibraryitemsoperator.md) | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/getlibraryitemsfilter.md
Normal file
12
docs/models/operations/getlibraryitemsfilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
9
docs/models/operations/getlibraryitemsflattenseasons.md
Normal file
9
docs/models/operations/getlibraryitemsflattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsFlattenSeasons
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------ | ------------------------------------ |
|
||||||
|
| `GetLibraryItemsFlattenSeasonsFalse` | 0 |
|
||||||
|
| `GetLibraryItemsFlattenSeasonsTrue` | 1 |
|
||||||
9
docs/models/operations/getlibraryitemshasthumbnail.md
Normal file
9
docs/models/operations/getlibraryitemshasthumbnail.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsHasThumbnail
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------------- | ---------------------------------- |
|
||||||
|
| `GetLibraryItemsHasThumbnailFalse` | 0 |
|
||||||
|
| `GetLibraryItemsHasThumbnailTrue` | 1 |
|
||||||
10
docs/models/operations/getlibraryitemsimage.md
Normal file
10
docs/models/operations/getlibraryitemsimage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `Type` | [operations.GetLibraryItemsLibraryResponse200Type](../../models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `URL` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------------- | ------------------------------------------------- |
|
||||||
|
| `GetLibraryItemsLibraryActiveDirectionAscending` | asc |
|
||||||
|
| `GetLibraryItemsLibraryActiveDirectionDescending` | desc |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `GetLibraryItemsLibraryDefaultDirectionAscending` | asc |
|
||||||
|
| `GetLibraryItemsLibraryDefaultDirectionDescending` | desc |
|
||||||
11
docs/models/operations/getlibraryitemslibraryfield.md
Normal file
11
docs/models/operations/getlibraryitemslibraryfield.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsLibraryField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsLibraryFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `Operator` | [][operations.GetLibraryItemsLibraryOperator](../../models/operations/getlibraryitemslibraryoperator.md) | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/getlibraryitemslibraryfilter.md
Normal file
12
docs/models/operations/getlibraryitemslibraryfilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
9
docs/models/operations/getlibraryitemslibraryoperator.md
Normal file
9
docs/models/operations/getlibraryitemslibraryoperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsLibraryOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsLibraryResponse200Type
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `GetLibraryItemsLibraryResponse200TypeCoverPoster` | coverPoster |
|
||||||
|
| `GetLibraryItemsLibraryResponse200TypeBackground` | background |
|
||||||
|
| `GetLibraryItemsLibraryResponse200TypeSnapshot` | snapshot |
|
||||||
|
| `GetLibraryItemsLibraryResponse200TypeClearLogo` | clearLogo |
|
||||||
14
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
14
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryItemsLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `Filter` | [][operations.GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Sort` | [][operations.GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Field` | [][operations.GetLibraryItemsLibraryField](../../models/operations/getlibraryitemslibraryfield.md) | :heavy_minus_sign: | N/A | |
|
||||||
15
docs/models/operations/getlibraryitemslibrarysort.md
Normal file
15
docs/models/operations/getlibraryitemslibrarysort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetLibraryItemsLibrarySort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `ActiveDirection` | [*operations.GetLibraryItemsLibraryActiveDirection](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DefaultDirection` | [*operations.GetLibraryItemsLibraryDefaultDirection](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `FirstCharacterKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||||
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------------------------------- | ----------------------------------- |
|
||||||
|
| `GetLibraryItemsLibraryTypeMovie` | movie |
|
||||||
|
| `GetLibraryItemsLibraryTypeTvShow` | show |
|
||||||
|
| `GetLibraryItemsLibraryTypeSeason` | season |
|
||||||
|
| `GetLibraryItemsLibraryTypeEpisode` | episode |
|
||||||
@@ -3,19 +3,23 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 119534 |
|
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 25025 |
|
| `Bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
|
||||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 3840 |
|
| `Width` | *int* | :heavy_check_mark: | N/A | 3840 |
|
||||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 2072 |
|
| `Height` | *int* | :heavy_check_mark: | N/A | 2072 |
|
||||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.85 |
|
| `AspectRatio` | *float64* | :heavy_check_mark: | N/A | 1.85 |
|
||||||
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 6 |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | eac3 |
|
| `AudioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
|
||||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
| `AudioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
|
||||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 4k |
|
| `VideoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
|
||||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
| `VideoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
|
||||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
| `VideoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
|
||||||
| `Part` | [][operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md) | :heavy_minus_sign: | N/A | |
|
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||||
|
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetLibraryItemsOptimizedForStreaming](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `Part` | [][operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,23 +1,33 @@
|
|||||||
# GetLibraryItemsMediaContainer
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 70 |
|
| `Type` | [][operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `FieldType` | [][operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
| `Size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `TotalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||||
| `LibrarySectionID` | [*operations.LibrarySectionID](../../models/operations/librarysectionid.md) | :heavy_minus_sign: | N/A | |
|
| `Offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||||
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
| `Nocache` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1701731894 |
|
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||||
| `Title1` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `LibrarySectionID` | *int64* | :heavy_check_mark: | N/A | 1 |
|
||||||
| `Title2` | **string* | :heavy_minus_sign: | N/A | Recently Released |
|
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
| `ViewGroup` | **string* | :heavy_minus_sign: | N/A | movie |
|
| `LibrarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||||
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `MediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
||||||
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_minus_sign: | N/A | |
|
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||||
|
| `Title1` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||||
|
| `Title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
|
||||||
|
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||||
|
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
||||||
|
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_check_mark: | N/A | |
|
||||||
|
| `Meta` | [*operations.GetLibraryItemsMeta](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
8
docs/models/operations/getlibraryitemsmediaguid.md
Normal file
8
docs/models/operations/getlibraryitemsmediaguid.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsMediaGUID
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `ID` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||||
12
docs/models/operations/getlibraryitemsmeta.md
Normal file
12
docs/models/operations/getlibraryitemsmeta.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsMeta
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | [][operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `FieldType` | [][operations.GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -5,24 +5,33 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `RatingKey` | **string* | :heavy_minus_sign: | N/A | 58683 |
|
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||||
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `GUID` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `Studio` | **string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `Studio` | **string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
| `SkipChildren` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
|
| `Type` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
|
| `Slug` | **string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
| `Summary` | **string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
| `Summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||||
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
||||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
||||||
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
|
| `SeasonCount` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||||
|
| `FlattenSeasons` | [*operations.GetLibraryItemsFlattenSeasons](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `ShowOrdering` | [*operations.GetLibraryItemsShowOrdering](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||||
|
| `Banner` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||||
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||||
| `AddedAt` | **int* | :heavy_minus_sign: | N/A | 1680457607 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `UpdatedAt` | **int* | :heavy_minus_sign: | N/A | 1703239236 |
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||||
@@ -32,14 +41,21 @@
|
|||||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
||||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `ParentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
|
| `GrandparentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | N/A | |
|
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||||
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
|
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
|
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Collection` | [][operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `MediaGUID` | [][operations.GetLibraryItemsMediaGUID](../../models/operations/getlibraryitemsmediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||||
|
| `UltraBlurColors` | [*operations.GetLibraryItemsUltraBlurColors](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `MetaDataRating` | [][operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Image` | [][operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
||||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||||
@@ -53,7 +69,7 @@
|
|||||||
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
|
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
||||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||||
|
|||||||
10
docs/models/operations/getlibraryitemsmetadatarating.md
Normal file
10
docs/models/operations/getlibraryitemsmetadatarating.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsMetaDataRating
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `Image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||||
|
| `Value` | *float32* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||||
9
docs/models/operations/getlibraryitemsoperator.md
Normal file
9
docs/models/operations/getlibraryitemsoperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------------------- | --------------------------------------------- |
|
||||||
|
| `GetLibraryItemsOptimizedForStreamingDisable` | 0 |
|
||||||
|
| `GetLibraryItemsOptimizedForStreamingEnable` | 1 |
|
||||||
@@ -5,10 +5,16 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 119542 |
|
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||||
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||||
| `Size` | **int64* | :heavy_minus_sign: | N/A | 36158371307 |
|
| `Size` | *int64* | :heavy_check_mark: | N/A | 36158371307 |
|
||||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
|
||||||
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `HasThumbnail` | [*operations.GetLibraryItemsHasThumbnail](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Stream` | [][operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryItemsQueryParamIncludeMeta
|
||||||
|
|
||||||
|
Adds the Meta object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------------------- | --------------------------------------------- |
|
||||||
|
| `GetLibraryItemsQueryParamIncludeMetaDisable` | 0 |
|
||||||
|
| `GetLibraryItemsQueryParamIncludeMetaEnable` | 1 |
|
||||||
19
docs/models/operations/getlibraryitemsqueryparamtype.md
Normal file
19
docs/models/operations/getlibraryitemsqueryparamtype.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetLibraryItemsQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------- | -------------------------------------- |
|
||||||
|
| `GetLibraryItemsQueryParamTypeMovie` | 1 |
|
||||||
|
| `GetLibraryItemsQueryParamTypeTvShow` | 2 |
|
||||||
|
| `GetLibraryItemsQueryParamTypeSeason` | 3 |
|
||||||
|
| `GetLibraryItemsQueryParamTypeEpisode` | 4 |
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
| `Tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
| `Tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||||
| `IncludeGuids` | [*operations.IncludeGuids](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
| `IncludeGuids` | [*operations.IncludeGuids](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||||
| `IncludeMeta` | [*operations.IncludeMeta](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `Type` | [*operations.GetLibraryItemsQueryParamType](../../models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `Type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `IncludeMeta` | [*operations.GetLibraryItemsQueryParamIncludeMeta](../../models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
@@ -3,6 +3,11 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
| `ID` | **int64* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||||
|
| `Filter` | **string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||||
|
| `TagKey` | **string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||||
|
| `Role` | **string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||||
20
docs/models/operations/getlibraryitemsshowordering.md
Normal file
20
docs/models/operations/getlibraryitemsshowordering.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsShowOrdering
|
||||||
|
|
||||||
|
Setting that indicates the episode ordering for the show
|
||||||
|
None = Library default,
|
||||||
|
tmdbAiring = The Movie Database (Aired),
|
||||||
|
aired = TheTVDB (Aired),
|
||||||
|
dvd = TheTVDB (DVD),
|
||||||
|
absolute = TheTVDB (Absolute)).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------------- | --------------------------------------- |
|
||||||
|
| `GetLibraryItemsShowOrderingNone` | None |
|
||||||
|
| `GetLibraryItemsShowOrderingTmdbAiring` | tmdbAiring |
|
||||||
|
| `GetLibraryItemsShowOrderingAired` | aired |
|
||||||
|
| `GetLibraryItemsShowOrderingDvd` | dvd |
|
||||||
|
| `GetLibraryItemsShowOrderingAbsolute` | absolute |
|
||||||
15
docs/models/operations/getlibraryitemssort.md
Normal file
15
docs/models/operations/getlibraryitemssort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetLibraryItemsSort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `ActiveDirection` | [*operations.GetLibraryItemsActiveDirection](../../models/operations/getlibraryitemsactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DefaultDirection` | [*operations.GetLibraryItemsDefaultDirection](../../models/operations/getlibraryitemsdefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `FirstCharacterKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||||
45
docs/models/operations/getlibraryitemsstream.md
Normal file
45
docs/models/operations/getlibraryitemsstream.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# GetLibraryItemsStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | N/A | 272796 |
|
||||||
|
| `StreamType` | *int64* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||||
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||||
|
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||||
|
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||||
|
| `Index` | *int64* | :heavy_check_mark: | The index of the stream | 0 |
|
||||||
|
| `Bitrate` | **int64* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||||
|
| `ColorPrimaries` | **string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||||
|
| `ColorRange` | **string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||||
|
| `ColorSpace` | **string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||||
|
| `ColorTrc` | **string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||||
|
| `BitDepth` | **int64* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||||
|
| `ChromaLocation` | **string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||||
|
| `StreamIdentifier` | **string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||||
|
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||||
|
| `CodedHeight` | **int64* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||||
|
| `CodedWidth` | **int64* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||||
|
| `FrameRate` | **float64* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||||
|
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||||
|
| `HearingImpaired` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Height` | **int64* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||||
|
| `Level` | **int64* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||||
|
| `Profile` | **string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||||
|
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||||
|
| `ScanType` | **string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||||
|
| `Width` | **int64* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||||
|
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||||
|
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||||
|
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||||
|
| `Language` | **string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||||
|
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||||
|
| `LanguageCode` | **string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||||
|
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||||
|
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||||
|
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||||
14
docs/models/operations/getlibraryitemstype.md
Normal file
14
docs/models/operations/getlibraryitemstype.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetLibraryItemsType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Sort` | [][operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Field` | [][operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getlibraryitemsultrablurcolors.md
Normal file
11
docs/models/operations/getlibraryitemsultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryItemsUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `TopLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||||
|
| `TopRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
|
| `BottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||||
|
| `BottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
@@ -3,16 +3,16 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 15 |
|
| `ID` | **int* | :heavy_minus_sign: | N/A | 15 |
|
||||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 141417 |
|
| `Duration` | **int* | :heavy_minus_sign: | N/A | 141417 |
|
||||||
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 40271948 |
|
| `Size` | **int* | :heavy_minus_sign: | N/A | 40271948 |
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
||||||
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | N/A | |
|
| `Stream` | [][operations.GetMetaDataByRatingKeyStream](../../models/operations/getmetadatabyratingkeystream.md) | :heavy_minus_sign: | N/A | |
|
||||||
39
docs/models/operations/getmetadatabyratingkeystream.md
Normal file
39
docs/models/operations/getmetadatabyratingkeystream.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# GetMetaDataByRatingKeyStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `ID` | **int* | :heavy_minus_sign: | N/A | 29 |
|
||||||
|
| `StreamType` | **int* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `Default` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `Codec` | **string* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `Index` | **int* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 128 |
|
||||||
|
| `BitDepth` | **int* | :heavy_minus_sign: | N/A | 8 |
|
||||||
|
| `ChromaLocation` | **string* | :heavy_minus_sign: | N/A | left |
|
||||||
|
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | N/A | 14520 |
|
||||||
|
| `CodedHeight` | **int* | :heavy_minus_sign: | N/A | 816 |
|
||||||
|
| `CodedWidth` | **int* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `ColorPrimaries` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `ColorRange` | **string* | :heavy_minus_sign: | N/A | tv |
|
||||||
|
| `ColorSpace` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `ColorTrc` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||||
|
| `FrameRate` | **int* | :heavy_minus_sign: | N/A | 24 |
|
||||||
|
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `Height` | **int* | :heavy_minus_sign: | N/A | 814 |
|
||||||
|
| `Level` | **int* | :heavy_minus_sign: | N/A | 40 |
|
||||||
|
| `Profile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `RefFrames` | **int* | :heavy_minus_sign: | N/A | 4 |
|
||||||
|
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `StreamIdentifier` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Width` | **int* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `DisplayTitle` | **string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||||
|
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||||
|
| `Selected` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `Channels` | **int* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `Language` | **string* | :heavy_minus_sign: | N/A | English |
|
||||||
|
| `LanguageTag` | **string* | :heavy_minus_sign: | N/A | en |
|
||||||
|
| `LanguageCode` | **string* | :heavy_minus_sign: | N/A | eng |
|
||||||
|
| `SamplingRate` | **int* | :heavy_minus_sign: | N/A | 44100 |
|
||||||
@@ -9,13 +9,13 @@ Requests a new pin id used in the authentication flow
|
|||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
|
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
|
||||||
| `Code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
|
| `Code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
|
||||||
| `Product` | *string* | :heavy_check_mark: | N/A | 0 |
|
| `Product` | *string* | :heavy_check_mark: | N/A | Tautulli |
|
||||||
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
|
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
| `Qr` | *string* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
|
| `Qr` | *string* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
|
||||||
| `ClientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | |
|
| `ClientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
|
||||||
| `Location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
|
| `Location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
|
||||||
| `ExpiresIn` | **int64* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
|
| `ExpiresIn` | **int64* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
|
||||||
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
|
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
|
||||||
| `ExpiresAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
|
| `ExpiresAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
|
||||||
| `AuthToken` | *any* | :heavy_minus_sign: | N/A | |
|
| `AuthToken` | **string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
|
||||||
| `NewRegistration` | *any* | :heavy_minus_sign: | N/A | |
|
| `NewRegistration` | *any* | :heavy_minus_sign: | N/A | |
|
||||||
@@ -5,4 +5,8 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `XPlexClientIdentifier` | **string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
| `ClientID` | **string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||||
|
| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||||
|
| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux |
|
||||||
|
| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||||
|
| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome |
|
||||||
@@ -6,5 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Strong` | **bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
| `Strong` | **bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||||
| `XPlexClientIdentifier` | **string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
| `ClientID` | **string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||||
| `XPlexProduct` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||||
|
| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux |
|
||||||
|
| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||||
|
| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome |
|
||||||
@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ---------------------------------------- | ---------------------------------------- |
|
| ------------------------------------------ | ------------------------------------------ |
|
||||||
| `GetPlaylistContentsQueryParamTypeOne` | 1 |
|
| `GetPlaylistContentsQueryParamTypeMovie` | 1 |
|
||||||
| `GetPlaylistContentsQueryParamTypeTwo` | 2 |
|
| `GetPlaylistContentsQueryParamTypeTvShow` | 2 |
|
||||||
| `GetPlaylistContentsQueryParamTypeThree` | 3 |
|
| `GetPlaylistContentsQueryParamTypeSeason` | 3 |
|
||||||
| `GetPlaylistContentsQueryParamTypeFour` | 4 |
|
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |
|
||||||
12
docs/models/operations/getrecentlyaddedactivedirection.md
Normal file
12
docs/models/operations/getrecentlyaddedactivedirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------- | ------------------------------------------- |
|
||||||
|
| `GetRecentlyAddedActiveDirectionAscending` | asc |
|
||||||
|
| `GetRecentlyAddedActiveDirectionDescending` | desc |
|
||||||
@@ -1,11 +1,12 @@
|
|||||||
# GetUserDetailsAuthenticationStatus
|
# GetRecentlyAddedDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
String representation of subscriptionActive
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| -------------------------------------------- | -------------------------------------------- |
|
| -------------------------------------------- | -------------------------------------------- |
|
||||||
| `GetUserDetailsAuthenticationStatusInactive` | Inactive |
|
| `GetRecentlyAddedDefaultDirectionAscending` | asc |
|
||||||
| `GetUserDetailsAuthenticationStatusActive` | Active |
|
| `GetRecentlyAddedDefaultDirectionDescending` | desc |
|
||||||
11
docs/models/operations/getrecentlyaddedfield.md
Normal file
11
docs/models/operations/getrecentlyaddedfield.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||||
9
docs/models/operations/getrecentlyaddedfieldtype.md
Normal file
9
docs/models/operations/getrecentlyaddedfieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetRecentlyAddedFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `Operator` | [][operations.GetRecentlyAddedOperator](../../models/operations/getrecentlyaddedoperator.md) | :heavy_check_mark: | N/A | |
|
||||||
12
docs/models/operations/getrecentlyaddedfilter.md
Normal file
12
docs/models/operations/getrecentlyaddedfilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
11
docs/models/operations/getrecentlyaddedhubsresponsetype.md
Normal file
11
docs/models/operations/getrecentlyaddedhubsresponsetype.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedHubsResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------------------- | --------------------------------------------- |
|
||||||
|
| `GetRecentlyAddedHubsResponseTypeCoverPoster` | coverPoster |
|
||||||
|
| `GetRecentlyAddedHubsResponseTypeBackground` | background |
|
||||||
|
| `GetRecentlyAddedHubsResponseTypeSnapshot` | snapshot |
|
||||||
|
| `GetRecentlyAddedHubsResponseTypeClearLogo` | clearLogo |
|
||||||
14
docs/models/operations/getrecentlyaddedhubstype.md
Normal file
14
docs/models/operations/getrecentlyaddedhubstype.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedHubsType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------- | --------------------------------- |
|
||||||
|
| `GetRecentlyAddedHubsTypeMovie` | movie |
|
||||||
|
| `GetRecentlyAddedHubsTypeTvShow` | show |
|
||||||
|
| `GetRecentlyAddedHubsTypeSeason` | season |
|
||||||
|
| `GetRecentlyAddedHubsTypeEpisode` | episode |
|
||||||
10
docs/models/operations/getrecentlyaddedimage.md
Normal file
10
docs/models/operations/getrecentlyaddedimage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `Type` | [operations.GetRecentlyAddedHubsResponseType](../../models/operations/getrecentlyaddedhubsresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `URL` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
8
docs/models/operations/getrecentlyaddedlibrarycountry.md
Normal file
8
docs/models/operations/getrecentlyaddedlibrarycountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||||
12
docs/models/operations/getrecentlyaddedlibraryfilter.md
Normal file
12
docs/models/operations/getrecentlyaddedlibraryfilter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetRecentlyAddedLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
8
docs/models/operations/getrecentlyaddedlibrarygenre.md
Normal file
8
docs/models/operations/getrecentlyaddedlibrarygenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Comedy |
|
||||||
23
docs/models/operations/getrecentlyaddedlibrarymedia.md
Normal file
23
docs/models/operations/getrecentlyaddedlibrarymedia.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetRecentlyAddedLibraryMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 120345 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 3623 |
|
||||||
|
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `Height` | **float64* | :heavy_minus_sign: | N/A | 804 |
|
||||||
|
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 2.35 |
|
||||||
|
| `AudioChannels` | **float64* | :heavy_minus_sign: | N/A | 6 |
|
||||||
|
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | ac3 |
|
||||||
|
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | h264 |
|
||||||
|
| `VideoResolution` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `OptimizedForStreaming` | **float64* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
||||||
|
| `Part` | [][operations.GetRecentlyAddedLibraryPart](../../models/operations/getrecentlyaddedlibrarypart.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetRecentlyAddedLibraryMediaContainer
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | [][operations.GetRecentlyAddedLibraryType](../../models/operations/getrecentlyaddedlibrarytype.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||||
|
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Metadata` | [][operations.GetRecentlyAddedLibraryMetadata](../../models/operations/getrecentlyaddedlibrarymetadata.md) | :heavy_minus_sign: | N/A | |
|
||||||
39
docs/models/operations/getrecentlyaddedlibrarymetadata.md
Normal file
39
docs/models/operations/getrecentlyaddedlibrarymetadata.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# GetRecentlyAddedLibraryMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `LibrarySectionID` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `RatingKey` | **float64* | :heavy_minus_sign: | N/A | 59398 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
||||||
|
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
||||||
|
| `Studio` | **string* | :heavy_minus_sign: | N/A | Marvel Studios |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
||||||
|
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
| `Summary` | **string* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
|
||||||
|
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 4.7 |
|
||||||
|
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 8.3 |
|
||||||
|
| `Year` | **float64* | :heavy_minus_sign: | N/A | 2023 |
|
||||||
|
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
||||||
|
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `OriginallyAvailableAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
||||||
|
| `AddedAt` | **float64* | :heavy_minus_sign: | N/A | 1681803215 |
|
||||||
|
| `UpdatedAt` | **float64* | :heavy_minus_sign: | N/A | 1681888010 |
|
||||||
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||||
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
||||||
|
| `Media` | [][operations.GetRecentlyAddedLibraryMedia](../../models/operations/getrecentlyaddedlibrarymedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Genre` | [][operations.GetRecentlyAddedLibraryGenre](../../models/operations/getrecentlyaddedlibrarygenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Director` | [][operations.GetRecentlyAddedLibraryDirector](../../models/operations/getrecentlyaddedlibrarydirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Writer` | [][operations.GetRecentlyAddedLibraryWriter](../../models/operations/getrecentlyaddedlibrarywriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Country` | [][operations.GetRecentlyAddedLibraryCountry](../../models/operations/getrecentlyaddedlibrarycountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Role` | [][operations.GetRecentlyAddedLibraryRole](../../models/operations/getrecentlyaddedlibraryrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
17
docs/models/operations/getrecentlyaddedlibrarypart.md
Normal file
17
docs/models/operations/getrecentlyaddedlibrarypart.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetRecentlyAddedLibraryPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 120353 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||||
|
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 3395307162 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `HasThumbnail` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
||||||
14
docs/models/operations/getrecentlyaddedlibraryrequest.md
Normal file
14
docs/models/operations/getrecentlyaddedlibraryrequest.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentDirectoryID` | **int64* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `PinnedContentDirectoryID` | []*int64* | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
|
||||||
|
| `SectionID` | **int64* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||||
|
| `Type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
|
| `IncludeMeta` | [*operations.QueryParamIncludeMeta](../../models/operations/queryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
|
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
11
docs/models/operations/getrecentlyaddedlibraryresponse.md
Normal file
11
docs/models/operations/getrecentlyaddedlibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetRecentlyAddedLibraryResponseBody](../../models/operations/getrecentlyaddedlibraryresponsebody.md) | :heavy_minus_sign: | The recently added content |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedLibraryResponseBody
|
||||||
|
|
||||||
|
The recently added content
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetRecentlyAddedLibraryMediaContainer](../../models/operations/getrecentlyaddedlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getrecentlyaddedlibraryrole.md
Normal file
8
docs/models/operations/getrecentlyaddedlibraryrole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetRecentlyAddedLibraryRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Paul Rudd |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user