mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 04:20:46 +00:00
Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
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
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: pr
|
||||
mode: direct
|
||||
set_version: ${{ github.event.inputs.set_version }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
go:
|
||||
version: 0.11.1
|
||||
version: 0.12.0
|
||||
additionalDependencies: {}
|
||||
allowUnknownFieldsInWeakUnions: false
|
||||
clientServerStatusCodesAsErrors: true
|
||||
|
||||
@@ -1,33 +1,39 @@
|
||||
speakeasyVersion: 1.393.1
|
||||
speakeasyVersion: 1.401.2
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
||||
sourceRevisionDigest: sha256:92a2a2049bfbf67bea601a6b1b77d274e83a2d3b6968a0bc02dc290b21c7689d
|
||||
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:5aa71ad96ca6de91143ee513c9880e08e555e7748fb4b5f8d069c6ab0c8f3069
|
||||
sourceBlobDigest: sha256:1cbef844e2856c2eabba4bd6d677d96c572fed13b27978d0d953aa06b224c02f
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
targets:
|
||||
plexgo:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:5aa71ad96ca6de91143ee513c9880e08e555e7748fb4b5f8d069c6ab0c8f3069
|
||||
sourceBlobDigest: sha256:1cbef844e2856c2eabba4bd6d677d96c572fed13b27978d0d953aa06b224c02f
|
||||
codeSamplesNamespace: code-samples-go-plexgo
|
||||
codeSamplesRevisionDigest: sha256:367216afa9fb24c1dc1897cadc3feb86418148d80ebe2f8263ec65dbba5f2cee
|
||||
outLocation: /github/workspace/repo
|
||||
codeSamplesRevisionDigest: sha256:366a4aca940e2161009b4efe3c83407ecf0d02ac6a9e3420964c593aa24e3a34
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
targets:
|
||||
plexgo:
|
||||
target: go
|
||||
source: my-source
|
||||
source: plexapi
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
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
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
plexapi:
|
||||
inputs:
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||
targets:
|
||||
plexgo:
|
||||
target: go
|
||||
source: my-source
|
||||
source: plexapi
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-go-plexgo
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-go-plexgo
|
||||
|
||||
202
README.md
202
README.md
@@ -54,7 +54,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
@@ -73,36 +77,21 @@ func main() {
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
### [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
|
||||
|
||||
### [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
|
||||
<details open>
|
||||
<summary>Available methods</summary>
|
||||
|
||||
### [Activities](docs/sdks/activities/README.md)
|
||||
|
||||
* [GetServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get 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)
|
||||
|
||||
* [GetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||
@@ -111,27 +100,11 @@ func main() {
|
||||
* [StartTask](docs/sdks/butler/README.md#starttask) - Start 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)
|
||||
|
||||
* [GetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global 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)
|
||||
|
||||
* [GetFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
@@ -147,16 +120,20 @@ func main() {
|
||||
* [GetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [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)
|
||||
|
||||
* [LogLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
* [LogMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
* [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)
|
||||
|
||||
* [CreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||
@@ -169,18 +146,34 @@ func main() {
|
||||
* [AddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a 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.
|
||||
* [GetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
* [GetUserDetails](docs/sdks/authentication/README.md#getuserdetails) - Get User Data By Token
|
||||
* [PostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
|
||||
* [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
|
||||
|
||||
### [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
|
||||
### [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
|
||||
|
||||
### [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)
|
||||
|
||||
@@ -189,11 +182,28 @@ func main() {
|
||||
* [GetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||
* [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)
|
||||
|
||||
* [GetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||
* [CheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for 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] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
@@ -216,7 +226,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
@@ -266,7 +280,11 @@ func main() {
|
||||
RetryConnectionErrors: false,
|
||||
}),
|
||||
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()
|
||||
@@ -287,11 +305,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.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
||||
| sdkerrors.GetServerCapabilitiesResponseBody | 400 | application/json |
|
||||
| sdkerrors.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -309,20 +327,24 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
res, err := s.Server.GetServerCapabilities(ctx)
|
||||
if err != nil {
|
||||
|
||||
var e *sdkerrors.GetServerCapabilitiesResponseBody
|
||||
var e *sdkerrors.GetServerCapabilitiesBadRequest
|
||||
if errors.As(err, &e) {
|
||||
// handle error
|
||||
log.Fatal(e.Error())
|
||||
}
|
||||
|
||||
var e *sdkerrors.GetServerCapabilitiesServerResponseBody
|
||||
var e *sdkerrors.GetServerCapabilitiesUnauthorized
|
||||
if errors.As(err, &e) {
|
||||
// handle error
|
||||
log.Fatal(e.Error())
|
||||
@@ -365,7 +387,11 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerIndex(0),
|
||||
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()
|
||||
@@ -403,7 +429,11 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
|
||||
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()
|
||||
@@ -434,7 +464,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
@@ -503,7 +537,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
@@ -548,21 +586,25 @@ d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on
|
||||
<!-- Start 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
|
||||
|
||||
The following global parameter is available.
|
||||
The following global parameters are available.
|
||||
|
||||
| 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
|
||||
(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
|
||||
@@ -579,21 +621,19 @@ import (
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
res, err := s.Plex.GetServerResources(ctx, operations.GetServerResourcesRequest{
|
||||
XPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
IncludeHTTPS: operations.IncludeHTTPSOne.ToPointer(),
|
||||
IncludeRelay: operations.IncludeRelayOne.ToPointer(),
|
||||
IncludeIPv6: operations.IncludeIPv6One.ToPointer(),
|
||||
})
|
||||
res, err := s.Plex.GetPin(ctx, operations.GetPinRequest{})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.PlexDevices != nil {
|
||||
if res.AuthPinContainer != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
142
RELEASES.md
142
RELEASES.md
@@ -762,4 +762,144 @@ Based on:
|
||||
### Generated
|
||||
- [go v0.11.1] .
|
||||
### 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 - .
|
||||
6
USAGE.md
6
USAGE.md
@@ -11,7 +11,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
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()
|
||||
|
||||
@@ -215,7 +215,7 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetServerActivitiesResponseBody
|
||||
var out sdkerrors.GetServerActivitiesBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -238,7 +238,7 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetServerActivitiesActivitiesResponseBody
|
||||
var out sdkerrors.GetServerActivitiesUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -440,7 +440,7 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.CancelServerActivitiesResponseBody
|
||||
var out sdkerrors.CancelServerActivitiesBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -463,7 +463,7 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.CancelServerActivitiesActivitiesResponseBody
|
||||
var out sdkerrors.CancelServerActivitiesUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
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.
|
||||
func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations.GetTransientTokenQueryParamType, scope operations.Scope, opts ...operations.Option) (*operations.GetTransientTokenResponse, error) {
|
||||
hookCtx := hooks.HookContext{
|
||||
@@ -197,7 +197,7 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetTransientTokenResponseBody
|
||||
var out sdkerrors.GetTransientTokenBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -220,7 +220,7 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetTransientTokenAuthenticationResponseBody
|
||||
var out sdkerrors.GetTransientTokenUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -427,7 +427,7 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetSourceConnectionInformationResponseBody
|
||||
var out sdkerrors.GetSourceConnectionInformationBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -450,7 +450,7 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetSourceConnectionInformationAuthenticationResponseBody
|
||||
var out sdkerrors.GetSourceConnectionInformationUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
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
|
||||
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{
|
||||
Context: ctx,
|
||||
OperationID: "getUserDetails",
|
||||
OperationID: "getTokenDetails",
|
||||
OAuth2Scopes: []string{},
|
||||
SecuritySource: s.sdkConfiguration.Security,
|
||||
}
|
||||
|
||||
request := operations.GetUserDetailsRequest{
|
||||
XPlexToken: xPlexToken,
|
||||
}
|
||||
|
||||
o := operations.Options{}
|
||||
supportedOptions := []string{
|
||||
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 {
|
||||
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("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 {
|
||||
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,
|
||||
ContentType: httpRes.Header.Get("Content-Type"),
|
||||
RawResponse: httpRes,
|
||||
@@ -660,7 +652,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out operations.GetUserDetailsUserPlexAccount
|
||||
var out operations.GetTokenDetailsUserPlexAccount
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -682,7 +674,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetUserDetailsResponseBody
|
||||
var out sdkerrors.GetTokenDetailsBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -705,7 +697,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetUserDetailsAuthenticationResponseBody
|
||||
var out sdkerrors.GetTokenDetailsUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -744,7 +736,7 @@ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string,
|
||||
|
||||
// PostUsersSignInData - Get User Sign In Data
|
||||
// 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.PostUsersSignInDataRequestBody, opts ...operations.Option) (*operations.PostUsersSignInDataResponse, error) {
|
||||
hookCtx := hooks.HookContext{
|
||||
Context: ctx,
|
||||
OperationID: "post-users-sign-in-data",
|
||||
@@ -752,15 +744,6 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
||||
SecuritySource: nil,
|
||||
}
|
||||
|
||||
request := operations.PostUsersSignInDataRequest{
|
||||
XPlexClientIdentifier: xPlexClientIdentifier,
|
||||
RequestBody: requestBody,
|
||||
}
|
||||
|
||||
globals := operations.PostUsersSignInDataGlobals{
|
||||
XPlexClientIdentifier: s.sdkConfiguration.Globals.XPlexClientIdentifier,
|
||||
}
|
||||
|
||||
o := operations.Options{}
|
||||
supportedOptions := []string{
|
||||
operations.SupportedOptionServerURL,
|
||||
@@ -784,7 +767,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
||||
return nil, fmt.Errorf("error generating URL: %w", err)
|
||||
}
|
||||
|
||||
bodyReader, reqContentType, err := utils.SerializeRequestBody(ctx, request, false, true, "RequestBody", "form", `request:"mediaType=application/x-www-form-urlencoded"`)
|
||||
bodyReader, reqContentType, err := utils.SerializeRequestBody(ctx, request, false, true, "Request", "form", `request:"mediaType=application/x-www-form-urlencoded"`)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -808,10 +791,6 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
||||
req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent)
|
||||
req.Header.Set("Content-Type", reqContentType)
|
||||
|
||||
if err := utils.PopulateQueryParams(ctx, req, request, globals); err != nil {
|
||||
return nil, fmt.Errorf("error populating query params: %w", err)
|
||||
}
|
||||
|
||||
globalRetryConfig := s.sdkConfiguration.RetryConfig
|
||||
retryConfig := o.Retries
|
||||
if retryConfig == nil {
|
||||
@@ -944,7 +923,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.PostUsersSignInDataResponseBody
|
||||
var out sdkerrors.PostUsersSignInDataBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -967,7 +946,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIde
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.PostUsersSignInDataAuthenticationResponseBody
|
||||
var out sdkerrors.PostUsersSignInDataUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
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
|
||||
}
|
||||
|
||||
var out sdkerrors.GetButlerTasksResponseBody
|
||||
var out sdkerrors.GetButlerTasksBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -232,7 +232,7 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.GetButlerTasksButlerResponseBody
|
||||
var out sdkerrors.GetButlerTasksUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -434,7 +434,7 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StartAllTasksResponseBody
|
||||
var out sdkerrors.StartAllTasksBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -457,7 +457,7 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StartAllTasksButlerResponseBody
|
||||
var out sdkerrors.StartAllTasksUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -655,7 +655,7 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StopAllTasksResponseBody
|
||||
var out sdkerrors.StopAllTasksBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -678,7 +678,7 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StopAllTasksButlerResponseBody
|
||||
var out sdkerrors.StopAllTasksUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -886,7 +886,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StartTaskResponseBody
|
||||
var out sdkerrors.StartTaskBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -909,7 +909,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StartTaskButlerResponseBody
|
||||
var out sdkerrors.StartTaskUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -1111,7 +1111,7 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StopTaskResponseBody
|
||||
var out sdkerrors.StopTaskBadRequest
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -1134,7 +1134,7 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out sdkerrors.StopTaskButlerResponseBody
|
||||
var out sdkerrors.StopTaskUnauthorized
|
||||
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
492
codeSamples.yaml
492
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------ | ------------------------ |
|
||||
| `AutoSelectSubtitleZero` | 0 |
|
||||
| `AutoSelectSubtitleOne` | 1 |
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `AutoSelectSubtitleDisable` | 0 |
|
||||
| `AutoSelectSubtitleEnable` | 1 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Protocol` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Address` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Port` | *float64* | :heavy_check_mark: | N/A |
|
||||
| `URI` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Local` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `IPv6` | *bool* | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `Protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
|
||||
| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
|
||||
| `Port` | *int* | :heavy_check_mark: | The port used for the connection |
|
||||
| `URI` | *string* | :heavy_check_mark: | The full URI of the connection |
|
||||
| `Local` | *bool* | :heavy_check_mark: | If the connection is local address |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct |
|
||||
| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# 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
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------- | ---------------------------------- |
|
||||
| `DefaultSubtitleAccessibilityZero` | 0 |
|
||||
| `DefaultSubtitleAccessibilityOne` | 1 |
|
||||
| Name | Value |
|
||||
| ------------------------------------- | ------------------------------------- |
|
||||
| `DefaultSubtitleAccessibilityDisable` | 0 |
|
||||
| `DefaultSubtitleAccessibilityEnable` | 1 |
|
||||
@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `DefaultSubtitleForcedZero` | 0 |
|
||||
| `DefaultSubtitleForcedOne` | 1 |
|
||||
| Name | Value |
|
||||
| ------------------------------ | ------------------------------ |
|
||||
| `DefaultSubtitleForcedDisable` | 0 |
|
||||
| `DefaultSubtitleForcedEnable` | 1 |
|
||||
@@ -13,7 +13,7 @@ Geo location data
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|
||||
@@ -5,24 +5,24 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Composite` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `Filters` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Refreshing` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `Agent` | **string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||
| `Scanner` | **string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||
| `Language` | **string* | :heavy_minus_sign: | N/A | en-US |
|
||||
| `UUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `CreatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `ScannedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `Content` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Directory` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `ContentChangedAt` | **int* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
| `Hidden` | **int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `Filters` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Refreshing` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `Agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `Scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `Language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `UUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `UpdatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `CreatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `ScannedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Content` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Directory` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `ContentChangedAt` | *int* | :heavy_check_mark: | N/A | 3192854 |
|
||||
| `Hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -8,4 +8,4 @@
|
||||
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `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
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|
||||
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 |
|
||||
@@ -3,21 +3,22 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 70 |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `LibrarySectionID` | [*operations.LibrarySectionID](../../models/operations/librarysectionid.md) | :heavy_minus_sign: | N/A | |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `Title1` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `Title2` | **string* | :heavy_minus_sign: | N/A | Recently Released |
|
||||
| `ViewGroup` | **string* | :heavy_minus_sign: | 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_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `Size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `LibrarySectionID` | [operations.LibrarySectionID](../../models/operations/librarysectionid.md) | :heavy_check_mark: | N/A | |
|
||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `LibrarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `MediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
||||
| `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_minus_sign: | N/A | |
|
||||
| `Meta` | [*operations.Meta](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -5,21 +5,21 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `RatingKey` | **string* | :heavy_minus_sign: | N/A | 58683 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
||||
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | N/A | 58683 |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `GUID` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `Studio` | **string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `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. |
|
||||
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `Year` | *int* | :heavy_check_mark: | N/A | 2022 |
|
||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `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 |
|
||||
| `UpdatedAt` | **int* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
@@ -34,12 +34,13 @@
|
||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/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 |
|
||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_check_mark: | 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 | |
|
||||
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MediaGUID` | [][operations.MediaGUID](../../models/operations/mediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
|
||||
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 |
|
||||
13
docs/models/operations/getlibraryitemssort.md
Normal file
13
docs/models/operations/getlibraryitemssort.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetLibraryItemsSort
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `DefaultDirection` | *string* | :heavy_check_mark: | N/A | 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/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 | |
|
||||
@@ -9,13 +9,13 @@ Requests a new pin id used in the authentication flow
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
|
||||
| `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 | |
|
||||
| `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/>} |
|
||||
| `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 |
|
||||
| `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 | |
|
||||
@@ -3,6 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `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 |
|
||||
@@ -3,8 +3,10 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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/> | |
|
||||
| `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 |
|
||||
| `XPlexProduct` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| 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/> | |
|
||||
| `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
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------------- | ---------------------------------------- |
|
||||
| `GetPlaylistContentsQueryParamTypeOne` | 1 |
|
||||
| `GetPlaylistContentsQueryParamTypeTwo` | 2 |
|
||||
| `GetPlaylistContentsQueryParamTypeThree` | 3 |
|
||||
| `GetPlaylistContentsQueryParamTypeFour` | 4 |
|
||||
| Name | Value |
|
||||
| ------------------------------------------ | ------------------------------------------ |
|
||||
| `GetPlaylistContentsQueryParamTypeMovie` | 1 |
|
||||
| `GetPlaylistContentsQueryParamTypeShow` | 2 |
|
||||
| `GetPlaylistContentsQueryParamTypeSeason` | 3 |
|
||||
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetServerResourcesGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -3,10 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `IncludeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `IncludeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
@@ -9,13 +9,13 @@ The Pin with a non-null authToken when it has been verified by the user
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
|
||||
| `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 | |
|
||||
| `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.GetTokenByPinIDGeoData](../../models/operations/gettokenbypinidgeodata.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 |
|
||||
| `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 |
|
||||
| `AuthToken` | *any* | :heavy_minus_sign: | N/A | |
|
||||
| `AuthToken` | **string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `NewRegistration` | *any* | :heavy_minus_sign: | N/A | |
|
||||
@@ -13,7 +13,7 @@ Geo location data
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetTokenByPinIDGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -3,7 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetTokenDetailsAuthenticationResponseStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `GetTokenDetailsAuthenticationResponseStatusInactive` | Inactive |
|
||||
| `GetTokenDetailsAuthenticationResponseStatusActive` | Active |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetTokenDetailsAuthenticationStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `GetTokenDetailsAuthenticationStatusInactive` | Inactive |
|
||||
| `GetTokenDetailsAuthenticationStatusActive` | Active |
|
||||
66
docs/models/operations/gettokendetailsfeatures.md
Normal file
66
docs/models/operations/gettokendetailsfeatures.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# GetTokenDetailsFeatures
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `GetTokenDetailsFeaturesAndroidDolbyVision` | Android - Dolby Vision |
|
||||
| `GetTokenDetailsFeaturesAndroidPiP` | Android - PiP |
|
||||
| `GetTokenDetailsFeaturesCuSunset` | CU Sunset |
|
||||
| `GetTokenDetailsFeaturesHrkEnableEur` | HRK_enable_EUR |
|
||||
| `GetTokenDetailsFeaturesTrebleShowFeatures` | TREBLE-show-features |
|
||||
| `GetTokenDetailsFeaturesAdCountdownTimer` | ad-countdown-timer |
|
||||
| `GetTokenDetailsFeaturesAdaptiveBitrate` | adaptive_bitrate |
|
||||
| `GetTokenDetailsFeaturesAmazonLoopDebug` | amazon-loop-debug |
|
||||
| `GetTokenDetailsFeaturesAvodAdAnalysis` | avod-ad-analysis |
|
||||
| `GetTokenDetailsFeaturesAvodNewMedia` | avod-new-media |
|
||||
| `GetTokenDetailsFeaturesBlacklistGetSignin` | blacklist_get_signin |
|
||||
| `GetTokenDetailsFeaturesClientRadioStations` | client-radio-stations |
|
||||
| `GetTokenDetailsFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `GetTokenDetailsFeaturesCollections` | collections |
|
||||
| `GetTokenDetailsFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `GetTokenDetailsFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `GetTokenDetailsFeaturesCompanionsSonos` | companions_sonos |
|
||||
| `GetTokenDetailsFeaturesCustomHomeRemoval` | custom-home-removal |
|
||||
| `GetTokenDetailsFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `GetTokenDetailsFeaturesDisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `GetTokenDetailsFeaturesDrmSupport` | drm_support |
|
||||
| `GetTokenDetailsFeaturesExcludeRestrictions` | exclude restrictions |
|
||||
| `GetTokenDetailsFeaturesFederatedAuth` | federated-auth |
|
||||
| `GetTokenDetailsFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GetTokenDetailsFeaturesGuidedUpgrade` | guided-upgrade |
|
||||
| `GetTokenDetailsFeaturesHome` | home |
|
||||
| `GetTokenDetailsFeaturesIncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `GetTokenDetailsFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `GetTokenDetailsFeaturesIterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `GetTokenDetailsFeaturesKeepPaymentMethod` | keep-payment-method |
|
||||
| `GetTokenDetailsFeaturesKevinBacon` | kevin-bacon |
|
||||
| `GetTokenDetailsFeaturesKoreaConsent` | korea-consent |
|
||||
| `GetTokenDetailsFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
|
||||
| `GetTokenDetailsFeaturesLetsEncrypt` | lets_encrypt |
|
||||
| `GetTokenDetailsFeaturesLightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `GetTokenDetailsFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `GetTokenDetailsFeaturesLivetv` | livetv |
|
||||
| `GetTokenDetailsFeaturesMetadataSearch` | metadata_search |
|
||||
| `GetTokenDetailsFeaturesNewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `GetTokenDetailsFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `GetTokenDetailsFeaturesPhotosFavorites` | photos-favorites |
|
||||
| `GetTokenDetailsFeaturesPhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `GetTokenDetailsFeaturesPmsHealth` | pms_health |
|
||||
| `GetTokenDetailsFeaturesRadio` | radio |
|
||||
| `GetTokenDetailsFeaturesRateLimitClientToken` | rate-limit-client-token |
|
||||
| `GetTokenDetailsFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `GetTokenDetailsFeaturesSharedServerNotification` | shared_server_notification |
|
||||
| `GetTokenDetailsFeaturesSharedSourceNotification` | shared_source_notification |
|
||||
| `GetTokenDetailsFeaturesSigninWithApple` | signin_with_apple |
|
||||
| `GetTokenDetailsFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `GetTokenDetailsFeaturesTranscoderCache` | transcoder_cache |
|
||||
| `GetTokenDetailsFeaturesTunerSharing` | tuner-sharing |
|
||||
| `GetTokenDetailsFeaturesTwoFactorAuthentication` | two-factor-authentication |
|
||||
| `GetTokenDetailsFeaturesUnsupportedtuners` | unsupportedtuners |
|
||||
| `GetTokenDetailsFeaturesUpgrade3ds2` | upgrade-3ds2 |
|
||||
| `GetTokenDetailsFeaturesVodSchema` | vod-schema |
|
||||
| `GetTokenDetailsFeaturesVodCloudflare` | vod_cloudflare |
|
||||
| `GetTokenDetailsFeaturesWatchTogetherInvite` | watch-together-invite |
|
||||
| `GetTokenDetailsFeaturesWebServerDashboard` | web_server_dashboard |
|
||||
File diff suppressed because one or more lines are too long
9
docs/models/operations/gettokendetailsstatus.md
Normal file
9
docs/models/operations/gettokendetailsstatus.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetTokenDetailsStatus
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------ | ------------------------------ |
|
||||
| `GetTokenDetailsStatusOnline` | online |
|
||||
| `GetTokenDetailsStatusOffline` | offline |
|
||||
@@ -1,13 +1,13 @@
|
||||
# GetUserDetailsSubscription
|
||||
# GetTokenDetailsSubscription
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Features` | [][operations.GetUserDetailsFeatures](../../models/operations/getuserdetailsfeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `Status` | [*operations.GetUserDetailsAuthenticationResponseStatus](../../models/operations/getuserdetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
| `PaymentService` | **string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `Plan` | **string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Features` | [][operations.GetTokenDetailsFeatures](../../models/operations/gettokendetailsfeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `Status` | [*operations.GetTokenDetailsAuthenticationResponseStatus](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
| `PaymentService` | **string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `Plan` | **string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetUserDetailsUserPlexAccount
|
||||
# GetTokenDetailsUserPlexAccount
|
||||
|
||||
Logged in user details
|
||||
|
||||
@@ -26,7 +26,7 @@ Logged in user details
|
||||
| `HomeAdmin` | **bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||||
| `HomeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
|
||||
| `ID` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||||
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
|
||||
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
|
||||
| `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||||
| `MailingListStatus` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
@@ -34,14 +34,14 @@ Logged in user details
|
||||
| ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `Profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
|
||||
| `Protected` | **bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||||
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
|
||||
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Restricted` | **bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||||
| `Roles` | []*string* | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||||
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||||
| `Services` | [][operations.Services](../../models/operations/services.md) | :heavy_check_mark: | N/A | |
|
||||
| `Subscription` | [operations.Subscription](../../models/operations/subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||||
| `SubscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||||
| `Subscriptions` | [][operations.GetUserDetailsSubscription](../../models/operations/getuserdetailssubscription.md) | :heavy_check_mark: | N/A | |
|
||||
| `Subscriptions` | [][operations.GetTokenDetailsSubscription](../../models/operations/gettokendetailssubscription.md) | :heavy_check_mark: | N/A | |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
||||
| `Title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `TwoFactorEnabled` | **bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||||
@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `GetTopWatchedContentQueryParamTypeOne` | 1 |
|
||||
| `GetTopWatchedContentQueryParamTypeTwo` | 2 |
|
||||
| `GetTopWatchedContentQueryParamTypeThree` | 3 |
|
||||
| `GetTopWatchedContentQueryParamTypeFour` | 4 |
|
||||
| Name | Value |
|
||||
| ------------------------------------------- | ------------------------------------------- |
|
||||
| `GetTopWatchedContentQueryParamTypeMovie` | 1 |
|
||||
| `GetTopWatchedContentQueryParamTypeShow` | 2 |
|
||||
| `GetTopWatchedContentQueryParamTypeSeason` | 3 |
|
||||
| `GetTopWatchedContentQueryParamTypeEpisode` | 4 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserDetailsAuthenticationResponseStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `GetUserDetailsAuthenticationResponseStatusInactive` | Inactive |
|
||||
| `GetUserDetailsAuthenticationResponseStatusActive` | Active |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetUserDetailsAuthenticationStatus
|
||||
|
||||
String representation of subscriptionActive
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------------------------- | -------------------------------------------- |
|
||||
| `GetUserDetailsAuthenticationStatusInactive` | Inactive |
|
||||
| `GetUserDetailsAuthenticationStatusActive` | Active |
|
||||
@@ -1,66 +0,0 @@
|
||||
# GetUserDetailsFeatures
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `GetUserDetailsFeaturesAndroidDolbyVision` | Android - Dolby Vision |
|
||||
| `GetUserDetailsFeaturesAndroidPiP` | Android - PiP |
|
||||
| `GetUserDetailsFeaturesCuSunset` | CU Sunset |
|
||||
| `GetUserDetailsFeaturesHrkEnableEur` | HRK_enable_EUR |
|
||||
| `GetUserDetailsFeaturesTrebleShowFeatures` | TREBLE-show-features |
|
||||
| `GetUserDetailsFeaturesAdCountdownTimer` | ad-countdown-timer |
|
||||
| `GetUserDetailsFeaturesAdaptiveBitrate` | adaptive_bitrate |
|
||||
| `GetUserDetailsFeaturesAmazonLoopDebug` | amazon-loop-debug |
|
||||
| `GetUserDetailsFeaturesAvodAdAnalysis` | avod-ad-analysis |
|
||||
| `GetUserDetailsFeaturesAvodNewMedia` | avod-new-media |
|
||||
| `GetUserDetailsFeaturesBlacklistGetSignin` | blacklist_get_signin |
|
||||
| `GetUserDetailsFeaturesClientRadioStations` | client-radio-stations |
|
||||
| `GetUserDetailsFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `GetUserDetailsFeaturesCollections` | collections |
|
||||
| `GetUserDetailsFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `GetUserDetailsFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `GetUserDetailsFeaturesCompanionsSonos` | companions_sonos |
|
||||
| `GetUserDetailsFeaturesCustomHomeRemoval` | custom-home-removal |
|
||||
| `GetUserDetailsFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `GetUserDetailsFeaturesDisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `GetUserDetailsFeaturesDrmSupport` | drm_support |
|
||||
| `GetUserDetailsFeaturesExcludeRestrictions` | exclude restrictions |
|
||||
| `GetUserDetailsFeaturesFederatedAuth` | federated-auth |
|
||||
| `GetUserDetailsFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GetUserDetailsFeaturesGuidedUpgrade` | guided-upgrade |
|
||||
| `GetUserDetailsFeaturesHome` | home |
|
||||
| `GetUserDetailsFeaturesIncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `GetUserDetailsFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `GetUserDetailsFeaturesIterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `GetUserDetailsFeaturesKeepPaymentMethod` | keep-payment-method |
|
||||
| `GetUserDetailsFeaturesKevinBacon` | kevin-bacon |
|
||||
| `GetUserDetailsFeaturesKoreaConsent` | korea-consent |
|
||||
| `GetUserDetailsFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
|
||||
| `GetUserDetailsFeaturesLetsEncrypt` | lets_encrypt |
|
||||
| `GetUserDetailsFeaturesLightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `GetUserDetailsFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `GetUserDetailsFeaturesLivetv` | livetv |
|
||||
| `GetUserDetailsFeaturesMetadataSearch` | metadata_search |
|
||||
| `GetUserDetailsFeaturesNewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `GetUserDetailsFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `GetUserDetailsFeaturesPhotosFavorites` | photos-favorites |
|
||||
| `GetUserDetailsFeaturesPhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `GetUserDetailsFeaturesPmsHealth` | pms_health |
|
||||
| `GetUserDetailsFeaturesRadio` | radio |
|
||||
| `GetUserDetailsFeaturesRateLimitClientToken` | rate-limit-client-token |
|
||||
| `GetUserDetailsFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `GetUserDetailsFeaturesSharedServerNotification` | shared_server_notification |
|
||||
| `GetUserDetailsFeaturesSharedSourceNotification` | shared_source_notification |
|
||||
| `GetUserDetailsFeaturesSigninWithApple` | signin_with_apple |
|
||||
| `GetUserDetailsFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `GetUserDetailsFeaturesTranscoderCache` | transcoder_cache |
|
||||
| `GetUserDetailsFeaturesTunerSharing` | tuner-sharing |
|
||||
| `GetUserDetailsFeaturesTwoFactorAuthentication` | two-factor-authentication |
|
||||
| `GetUserDetailsFeaturesUnsupportedtuners` | unsupportedtuners |
|
||||
| `GetUserDetailsFeaturesUpgrade3ds2` | upgrade-3ds2 |
|
||||
| `GetUserDetailsFeaturesVodSchema` | vod-schema |
|
||||
| `GetUserDetailsFeaturesVodCloudflare` | vod_cloudflare |
|
||||
| `GetUserDetailsFeaturesWatchTogetherInvite` | watch-together-invite |
|
||||
| `GetUserDetailsFeaturesWebServerDashboard` | web_server_dashboard |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetUserDetailsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetUserDetailsStatus
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------- | ----------------------------- |
|
||||
| `GetUserDetailsStatusOnline` | online |
|
||||
| `GetUserDetailsStatusOffline` | offline |
|
||||
@@ -6,7 +6,7 @@ Adds the Guids object to the response
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `IncludeGuidsZero` | 0 |
|
||||
| `IncludeGuidsOne` | 1 |
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `IncludeGuidsDisable` | 0 |
|
||||
| `IncludeGuidsEnable` | 1 |
|
||||
@@ -5,7 +5,7 @@ Include Https entries in the results
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `IncludeHTTPSZero` | 0 |
|
||||
| `IncludeHTTPSOne` | 1 |
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `IncludeHTTPSDisable` | 0 |
|
||||
| `IncludeHTTPSEnable` | 1 |
|
||||
@@ -5,7 +5,7 @@ Include IPv6 entries in the results
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------- | ----------------- |
|
||||
| `IncludeIPv6Zero` | 0 |
|
||||
| `IncludeIPv6One` | 1 |
|
||||
| Name | Value |
|
||||
| -------------------- | -------------------- |
|
||||
| `IncludeIPv6Disable` | 0 |
|
||||
| `IncludeIPv6Enable` | 1 |
|
||||
@@ -6,7 +6,7 @@ Adds the Meta object to the response
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------- | ----------------- |
|
||||
| `IncludeMetaZero` | 0 |
|
||||
| `IncludeMetaOne` | 1 |
|
||||
| Name | Value |
|
||||
| -------------------- | -------------------- |
|
||||
| `IncludeMetaDisable` | 0 |
|
||||
| `IncludeMetaEnable` | 1 |
|
||||
@@ -7,7 +7,7 @@ E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `IncludeRelayZero` | 0 |
|
||||
| `IncludeRelayOne` | 1 |
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `IncludeRelayDisable` | 0 |
|
||||
| `IncludeRelayEnable` | 1 |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Path` | **string* | :heavy_minus_sign: | N/A | /movies |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
8
docs/models/operations/mediaguid.md
Normal file
8
docs/models/operations/mediaguid.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# MediaGUID
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,9 +1,11 @@
|
||||
# MediaReviewsVisibility
|
||||
|
||||
Whether or not the account has media reviews visibility enabled
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------- | ---------------------------- |
|
||||
| `MediaReviewsVisibilityZero` | 0 |
|
||||
| `MediaReviewsVisibilityOne` | 1 |
|
||||
| Name | Value |
|
||||
| ------------------------------- | ------------------------------- |
|
||||
| `MediaReviewsVisibilityDisable` | 0 |
|
||||
| `MediaReviewsVisibilityEnable` | 1 |
|
||||
@@ -1,11 +1,12 @@
|
||||
# GetTokenByPinIDPlexResponseBody
|
||||
# Meta
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
Not Found or Expired
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `Errors` | [][sdkerrors.GetTokenByPinIDPlexErrors](../../models/sdkerrors/gettokenbypinidplexerrors.md) | :heavy_minus_sign: | N/A |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Type` | [][operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_minus_sign: | N/A |
|
||||
| `FieldType` | [][operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -3,29 +3,29 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `Name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Product` | *string* | :heavy_check_mark: | N/A |
|
||||
| `ProductVersion` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Platform` | *string* | :heavy_check_mark: | N/A |
|
||||
| `PlatformVersion` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Device` | *string* | :heavy_check_mark: | N/A |
|
||||
| `ClientIdentifier` | *string* | :heavy_check_mark: | N/A |
|
||||
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A |
|
||||
| `LastSeenAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A |
|
||||
| `Provides` | *string* | :heavy_check_mark: | N/A |
|
||||
| `OwnerID` | *int64* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request |
|
||||
| `SourceTitle` | *string* | :heavy_check_mark: | N/A |
|
||||
| `PublicAddress` | *string* | :heavy_check_mark: | N/A |
|
||||
| `AccessToken` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Owned` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Home` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Synced` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Presence` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `HTTPSRequired` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `PublicAddressMatches` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `DNSRebindingProtection` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `NatLoopbackSupported` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Connections` | [][operations.Connections](../../models/operations/connections.md) | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `Name` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Product` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `ProductVersion` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Platform` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `PlatformVersion` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Device` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `ClientIdentifier` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
|
||||
| `LastSeenAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
|
||||
| `Provides` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `OwnerID` | *int64* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
|
||||
| `SourceTitle` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `PublicAddress` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `AccessToken` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Owned` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `Home` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `Synced` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `Presence` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `HTTPSRequired` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `PublicAddressMatches` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `DNSRebindingProtection` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `NatLoopbackSupported` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `Connections` | [][operations.Connections](../../models/operations/connections.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------------------- | ------------------------------------------- |
|
||||
| `PostUsersSignInDataAutoSelectSubtitleZero` | 0 |
|
||||
| `PostUsersSignInDataAutoSelectSubtitleOne` | 1 |
|
||||
| Name | Value |
|
||||
| ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `PostUsersSignInDataAutoSelectSubtitleDisable` | 0 |
|
||||
| `PostUsersSignInDataAutoSelectSubtitleEnable` | 1 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# PostUsersSignInDataDefaultSubtitleAccessibility
|
||||
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `PostUsersSignInDataDefaultSubtitleAccessibilityZero` | 0 |
|
||||
| `PostUsersSignInDataDefaultSubtitleAccessibilityOne` | 1 |
|
||||
| Name | Value |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `PostUsersSignInDataDefaultSubtitleAccessibilityDisable` | 0 |
|
||||
| `PostUsersSignInDataDefaultSubtitleAccessibilityEnable` | 1 |
|
||||
@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `PostUsersSignInDataDefaultSubtitleForcedZero` | 0 |
|
||||
| `PostUsersSignInDataDefaultSubtitleForcedOne` | 1 |
|
||||
| Name | Value |
|
||||
| ------------------------------------------------- | ------------------------------------------------- |
|
||||
| `PostUsersSignInDataDefaultSubtitleForcedDisable` | 0 |
|
||||
| `PostUsersSignInDataDefaultSubtitleForcedEnable` | 1 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# PostUsersSignInDataGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
@@ -1,9 +1,11 @@
|
||||
# PostUsersSignInDataMediaReviewsVisibility
|
||||
|
||||
Whether or not the account has media reviews visibility enabled
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------------- | ----------------------------------------------- |
|
||||
| `PostUsersSignInDataMediaReviewsVisibilityZero` | 0 |
|
||||
| `PostUsersSignInDataMediaReviewsVisibilityOne` | 1 |
|
||||
| Name | Value |
|
||||
| -------------------------------------------------- | -------------------------------------------------- |
|
||||
| `PostUsersSignInDataMediaReviewsVisibilityDisable` | 0 |
|
||||
| `PostUsersSignInDataMediaReviewsVisibilityEnable` | 1 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# PostUsersSignInDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `RequestBody` | [*operations.PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
|
||||
@@ -26,7 +26,7 @@ Returns the user account data with a valid auth token
|
||||
| `HomeAdmin` | **bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||||
| `HomeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
|
||||
| `ID` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||||
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
|
||||
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
|
||||
| `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||||
| `MailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
@@ -34,7 +34,7 @@ Returns the user account data with a valid auth token
|
||||
| ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `Profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
|
||||
| `Protected` | **bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||||
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
|
||||
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Restricted` | **bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||||
| `Roles` | []*string* | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||||
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||||
|
||||
@@ -3,13 +3,13 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AutoSelectAudio` | **bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
|
||||
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
|
||||
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
|
||||
| `AutoSelectSubtitle` | [*operations.PostUsersSignInDataAutoSelectSubtitle](../../models/operations/postuserssignindataautoselectsubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
|
||||
| `DefaultSubtitleAccessibility` | [*operations.PostUsersSignInDataDefaultSubtitleAccessibility](../../models/operations/postuserssignindatadefaultsubtitleaccessibility.md) | :heavy_minus_sign: | 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) | 1 |
|
||||
| `DefaultSubtitleForced` | [*operations.PostUsersSignInDataDefaultSubtitleForced](../../models/operations/postuserssignindatadefaultsubtitleforced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
|
||||
| `WatchedIndicator` | [*operations.PostUsersSignInDataWatchedIndicator](../../models/operations/postuserssignindatawatchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `MediaReviewsVisibility` | [*operations.PostUsersSignInDataMediaReviewsVisibility](../../models/operations/postuserssignindatamediareviewsvisibility.md) | :heavy_minus_sign: | N/A | 0 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AutoSelectAudio` | **bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
|
||||
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
|
||||
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
|
||||
| `AutoSelectSubtitle` | [*operations.PostUsersSignInDataAutoSelectSubtitle](../../models/operations/postuserssignindataautoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `DefaultSubtitleAccessibility` | [*operations.PostUsersSignInDataDefaultSubtitleAccessibility](../../models/operations/postuserssignindatadefaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `DefaultSubtitleForced` | [*operations.PostUsersSignInDataDefaultSubtitleForced](../../models/operations/postuserssignindatadefaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `WatchedIndicator` | [*operations.PostUsersSignInDataWatchedIndicator](../../models/operations/postuserssignindatawatchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `MediaReviewsVisibility` | [*operations.PostUsersSignInDataMediaReviewsVisibility](../../models/operations/postuserssignindatamediareviewsvisibility.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -1,9 +1,11 @@
|
||||
# PostUsersSignInDataWatchedIndicator
|
||||
|
||||
Whether or not media watched indicators are enabled (little orange dot on media)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `PostUsersSignInDataWatchedIndicatorZero` | 0 |
|
||||
| `PostUsersSignInDataWatchedIndicatorOne` | 1 |
|
||||
| Name | Value |
|
||||
| -------------------------------------------- | -------------------------------------------- |
|
||||
| `PostUsersSignInDataWatchedIndicatorDisable` | 0 |
|
||||
| `PostUsersSignInDataWatchedIndicatorEnable` | 1 |
|
||||
11
docs/models/operations/protocol.md
Normal file
11
docs/models/operations/protocol.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Protocol
|
||||
|
||||
The protocol used for the connection (http, https, etc)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `ProtocolHTTP` | http |
|
||||
| `ProtocolHTTPS` | https |
|
||||
@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `QueryParamTypeOne` | 1 |
|
||||
| `QueryParamTypeTwo` | 2 |
|
||||
| `QueryParamTypeThree` | 3 |
|
||||
| `QueryParamTypeFour` | 4 |
|
||||
| Name | Value |
|
||||
| ----------------------- | ----------------------- |
|
||||
| `QueryParamTypeMovie` | 1 |
|
||||
| `QueryParamTypeShow` | 2 |
|
||||
| `QueryParamTypeSeason` | 3 |
|
||||
| `QueryParamTypeEpisode` | 4 |
|
||||
@@ -3,10 +3,10 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
|
||||
| `Endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
|
||||
| `Token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
|
||||
| `Secret` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Status` | [operations.GetUserDetailsStatus](../../models/operations/getuserdetailsstatus.md) | :heavy_check_mark: | N/A | online |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
|
||||
| `Endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
|
||||
| `Token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
|
||||
| `Secret` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Status` | [operations.GetTokenDetailsStatus](../../models/operations/gettokendetailsstatus.md) | :heavy_check_mark: | N/A | online |
|
||||
@@ -5,11 +5,11 @@ If the account’s Plex Pass subscription is active
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `Features` | [][operations.Features](../../models/operations/features.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `Status` | [*operations.GetUserDetailsAuthenticationStatus](../../models/operations/getuserdetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
| `PaymentService` | **string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `Plan` | **string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `Features` | [][operations.Features](../../models/operations/features.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
|
||||
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
|
||||
| `Status` | [*operations.GetTokenDetailsAuthenticationStatus](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
|
||||
| `PaymentService` | **string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
|
||||
| `Plan` | **string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |
|
||||
@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `TypeOne` | 1 |
|
||||
| `TypeTwo` | 2 |
|
||||
| `TypeThree` | 3 |
|
||||
| `TypeFour` | 4 |
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `TypeMovie` | 1 |
|
||||
| `TypeShow` | 2 |
|
||||
| `TypeSeason` | 3 |
|
||||
| `TypeEpisode` | 4 |
|
||||
@@ -6,4 +6,5 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
|
||||
| `Force` | [operations.QueryParamForce](../../models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `Force` | [operations.QueryParamForce](../../models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `SectionID` | *int64* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
@@ -3,13 +3,13 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AutoSelectAudio` | **bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
|
||||
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
|
||||
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
|
||||
| `AutoSelectSubtitle` | [*operations.AutoSelectSubtitle](../../models/operations/autoselectsubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
|
||||
| `DefaultSubtitleAccessibility` | [*operations.DefaultSubtitleAccessibility](../../models/operations/defaultsubtitleaccessibility.md) | :heavy_minus_sign: | 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) | 1 |
|
||||
| `DefaultSubtitleForced` | [*operations.DefaultSubtitleForced](../../models/operations/defaultsubtitleforced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
|
||||
| `WatchedIndicator` | [*operations.WatchedIndicator](../../models/operations/watchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `MediaReviewsVisibility` | [*operations.MediaReviewsVisibility](../../models/operations/mediareviewsvisibility.md) | :heavy_minus_sign: | N/A | 0 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `AutoSelectAudio` | **bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
|
||||
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
|
||||
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
|
||||
| `AutoSelectSubtitle` | [*operations.AutoSelectSubtitle](../../models/operations/autoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `DefaultSubtitleAccessibility` | [*operations.DefaultSubtitleAccessibility](../../models/operations/defaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `DefaultSubtitleForced` | [*operations.DefaultSubtitleForced](../../models/operations/defaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `WatchedIndicator` | [*operations.WatchedIndicator](../../models/operations/watchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `MediaReviewsVisibility` | [*operations.MediaReviewsVisibility](../../models/operations/mediareviewsvisibility.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -1,9 +1,11 @@
|
||||
# WatchedIndicator
|
||||
|
||||
Whether or not media watched indicators are enabled (little orange dot on media)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `WatchedIndicatorZero` | 0 |
|
||||
| `WatchedIndicatorOne` | 1 |
|
||||
| Name | Value |
|
||||
| ------------------------- | ------------------------- |
|
||||
| `WatchedIndicatorDisable` | 0 |
|
||||
| `WatchedIndicatorEnable` | 1 |
|
||||
@@ -1,4 +1,4 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
# AddPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# AddPlaylistContentsPlaylistsResponseBody
|
||||
# AddPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
# ApplyUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ApplyUpdatesUpdaterResponseBody
|
||||
# ApplyUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
# CancelServerActivitiesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CancelServerActivitiesActivitiesResponseBody
|
||||
# CancelServerActivitiesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
# CheckForUpdatesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CheckForUpdatesUpdaterResponseBody
|
||||
# CheckForUpdatesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
# ClearPlaylistContentsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ClearPlaylistContentsPlaylistsResponseBody
|
||||
# ClearPlaylistContentsUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CreatePlaylistResponseBody
|
||||
# CreatePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# CreatePlaylistPlaylistsResponseBody
|
||||
# CreatePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DeleteLibraryResponseBody
|
||||
# DeleteLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DeleteLibraryLibraryResponseBody
|
||||
# DeleteLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DeletePlaylistResponseBody
|
||||
# DeletePlaylistBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DeletePlaylistPlaylistsResponseBody
|
||||
# DeletePlaylistUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
# EnablePaperTrailBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# EnablePaperTrailLogResponseBody
|
||||
# EnablePaperTrailUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetAllLibrariesResponseBody
|
||||
# GetAllLibrariesBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetAllLibrariesLibraryResponseBody
|
||||
# GetAllLibrariesUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
# GetAvailableClientsBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user