mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-07 12:37:45 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
673a771f04 | ||
|
|
216a94fe7d | ||
|
|
88d690ffc2 | ||
|
|
48a739d923 | ||
|
|
8b50020e1e | ||
|
|
4bcd080211 | ||
|
|
2e0f3b64ea | ||
|
|
9b0ac863a4 |
File diff suppressed because one or more lines are too long
@@ -15,7 +15,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
go:
|
||||
version: 0.19.1
|
||||
version: 0.21.0
|
||||
additionalDependencies: {}
|
||||
allowUnknownFieldsInWeakUnions: false
|
||||
clientServerStatusCodesAsErrors: true
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.513.4
|
||||
speakeasyVersion: 1.535.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,19 +9,19 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1741392494
|
||||
- speakeasy-sdk-regen-1745082762
|
||||
targets:
|
||||
plexgo:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||
codeSamplesNamespace: code-samples-go-plexgo
|
||||
codeSamplesRevisionDigest: sha256:01609ce90e3ede4fb9713410186aab8747cf7992930126be0a0e4af56761e5e0
|
||||
codeSamplesRevisionDigest: sha256:2d25718f4996da172444f082138e8a821c79218d583115151e7d1ebe953e7def
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -37,3 +37,5 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-go-plexgo
|
||||
labelOverride:
|
||||
fixedValue: PlexGO
|
||||
|
||||
@@ -12,3 +12,5 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-go-plexgo
|
||||
labelOverride:
|
||||
fixedValue: PlexGO
|
||||
|
||||
@@ -150,9 +150,12 @@ func main() {
|
||||
* [GetActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
* [GetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [GetMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
* [GetMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||
* [PostMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||
* [GetMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
* [PostMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||
* [GetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [GetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [GetOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [Log](docs/sdks/log/README.md)
|
||||
|
||||
|
||||
72
RELEASES.md
72
RELEASES.md
@@ -1062,4 +1062,74 @@ Based on:
|
||||
### Generated
|
||||
- [go v0.19.1] .
|
||||
### Releases
|
||||
- [Go v0.19.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.19.1 - .
|
||||
- [Go v0.19.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.19.1 - .
|
||||
|
||||
## 2025-03-10 00:08:31
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.19.2] .
|
||||
### Releases
|
||||
- [Go v0.19.2] https://github.com/LukeHagar/plexgo/releases/tag/v0.19.2 - .
|
||||
|
||||
## 2025-03-31 17:29:50
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.19.3] .
|
||||
### Releases
|
||||
- [Go v0.19.3] https://github.com/LukeHagar/plexgo/releases/tag/v0.19.3 - .
|
||||
|
||||
## 2025-04-03 21:55:33
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.20.0] .
|
||||
### Releases
|
||||
- [Go v0.20.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.20.0 - .
|
||||
|
||||
## 2025-04-07 00:10:20
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.20.1] .
|
||||
### Releases
|
||||
- [Go v0.20.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.20.1 - .
|
||||
|
||||
## 2025-04-15 00:10:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.20.2] .
|
||||
### Releases
|
||||
- [Go v0.20.2] https://github.com/LukeHagar/plexgo/releases/tag/v0.20.2 - .
|
||||
|
||||
## 2025-04-18 22:59:48
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.20.3] .
|
||||
### Releases
|
||||
- [Go v0.20.3] https://github.com/LukeHagar/plexgo/releases/tag/v0.20.3 - .
|
||||
|
||||
## 2025-04-19 17:12:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.21.0] .
|
||||
### Releases
|
||||
- [Go v0.21.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.21.0 - .
|
||||
305
codeSamples.yaml
305
codeSamples.yaml
@@ -7,7 +7,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getServerCapabilities
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -36,7 +36,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getServerPreferences
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -65,7 +65,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: updatePlayProgress
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -94,7 +94,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: markPlayed
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -123,7 +123,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTimeline
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -164,7 +164,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: markUnplayed
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -193,7 +193,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getServerActivities
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -222,7 +222,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: cancelServerActivities
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -251,7 +251,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: stopAllTasks
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -280,7 +280,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getButlerTasks
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -309,7 +309,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: startAllTasks
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -338,7 +338,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: stopTask
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -368,7 +368,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: startTask
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -398,7 +398,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getAvailableClients
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -427,7 +427,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getCompanionsData
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -456,7 +456,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getDevices
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -485,7 +485,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getUserFriends
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -514,7 +514,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getGeoData
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -541,7 +541,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getHomeData
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -570,7 +570,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getGlobalHubs
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -599,7 +599,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-recently-added
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -633,7 +633,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: performSearch
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -662,7 +662,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: performVoiceSearch
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -691,7 +691,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getLibraryHubs
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -720,7 +720,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-server-identity
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -747,7 +747,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTopWatchedContent
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -777,7 +777,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getFileHash
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -806,7 +806,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-media-meta-data
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -847,11 +847,69 @@ actions:
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetMediaArts(ctx, 16099)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.PostMediaArts(ctx, 2268, plexgo.String("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"), nil)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-banner-image
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -888,7 +946,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getMetadataChildren
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -913,11 +971,69 @@ actions:
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetMediaPosters(ctx, 16099)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.PostMediaPoster(ctx, 2268, plexgo.String("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"), nil)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-thumb-image
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -950,40 +1066,11 @@ actions:
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/onDeck"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getOnDeck
|
||||
source: |-
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetOnDeck(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-recently-added-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1031,7 +1118,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-search-all-libraries
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1067,7 +1154,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-all-libraries
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1096,7 +1183,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-watch-list
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1129,7 +1216,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: deleteLibrary
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1158,7 +1245,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-library-details
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1187,7 +1274,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-actors-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1217,7 +1304,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-all-media-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1250,7 +1337,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-countries-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1280,7 +1367,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-genres-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1310,7 +1397,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-refresh-library-metadata
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1340,7 +1427,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-search-library
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1370,7 +1457,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-library-items
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1404,7 +1491,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: logLine
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1434,7 +1521,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: logMultiLine
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1465,7 +1552,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: enablePaperTrail
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1494,7 +1581,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-media-providers
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1523,7 +1610,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getMyPlexAccount
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1552,7 +1639,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getResizedPhoto
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1590,7 +1677,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getPin
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1624,7 +1711,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTokenByPinId
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1659,7 +1746,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getPlaylists
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1688,7 +1775,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: createPlaylist
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1723,7 +1810,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: uploadPlaylist
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1753,7 +1840,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: deletePlaylist
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1782,7 +1869,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getPlaylist
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1811,7 +1898,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: updatePlaylist
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1840,7 +1927,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: clearPlaylistContents
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1869,7 +1956,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getPlaylistContents
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1899,7 +1986,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: addPlaylistContents
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1928,7 +2015,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-server-resources
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1957,7 +2044,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getSearchResults
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -1986,7 +2073,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getSourceConnectionInformation
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2015,7 +2102,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTransientToken
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2045,7 +2132,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getServerList
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2074,7 +2161,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getBandwidthStatistics
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2103,7 +2190,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getStatistics
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2132,7 +2219,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getResourcesStatistics
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2161,7 +2248,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getSessions
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2190,7 +2277,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getSessionHistory
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2220,7 +2307,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTranscodeSessions
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2249,7 +2336,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: stopTranscodeSession
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2278,7 +2365,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: applyUpdates
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2308,7 +2395,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: checkForUpdates
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2338,7 +2425,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getUpdateStatus
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2367,7 +2454,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: getTokenDetails
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2396,7 +2483,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: get-users
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2438,7 +2525,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: post-users-sign-in-data
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
@@ -2477,7 +2564,7 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: go
|
||||
label: startUniversalTranscode
|
||||
label: PlexGO
|
||||
source: |-
|
||||
package main
|
||||
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -1,8 +1,12 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 259 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `Filter` | **string* | :heavy_minus_sign: | N/A | country=19 |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
@@ -1,8 +1,12 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 259 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
@@ -3,26 +3,26 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `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` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `Location` | [][operations.GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md) | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `Composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `Filters` | *bool* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `Refreshing` | *bool* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `Key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `Type` | [operations.GetAllLibrariesType](../../models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `Agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `Scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `Language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `UUID` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `UpdatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `CreatedAt` | **int64* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `ScannedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Content` | *bool* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `Directory` | *bool* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `ContentChangedAt` | *int64* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||
| `Hidden` | [*operations.Hidden](../../models/operations/hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Location` | [][operations.GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `ID` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||
| `Path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `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_check_mark: | N/A | |
|
||||
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_minus_sign: | 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_check_mark: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
15
docs/models/operations/getalllibrariestype.md
Normal file
15
docs/models/operations/getalllibrariestype.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetAllLibrariesType
|
||||
|
||||
The library type
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------- | ---------------------------- |
|
||||
| `GetAllLibrariesTypeMovie` | movie |
|
||||
| `GetAllLibrariesTypeTvShow` | show |
|
||||
| `GetAllLibrariesTypeSeason` | season |
|
||||
| `GetAllLibrariesTypeEpisode` | episode |
|
||||
| `GetAllLibrariesTypeArtist` | artist |
|
||||
| `GetAllLibrariesTypeAlbum` | album |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
8
docs/models/operations/getallmedialibraryguids.md
Normal file
8
docs/models/operations/getallmedialibraryguids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetAllMediaLibraryGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `ID` | **string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||
@@ -19,8 +19,8 @@
|
||||
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `OptimizedForStreaming` | [*operations.GetAllMediaLibraryOptimizedForStreaming](../../models/operations/getallmedialibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Part` | [][operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md) | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
| `Part` | [][operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md) | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -20,7 +20,7 @@ Unknown
|
||||
| `Summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||
| `Rating` | *float32* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `AudienceRating` | *float64* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `Year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
|
||||
| `Year` | **int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
@@ -70,5 +70,5 @@ Unknown
|
||||
| `Director` | [][operations.GetAllMediaLibraryDirector](../../models/operations/getallmedialibrarydirector.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.GetAllMediaLibraryWriter](../../models/operations/getallmedialibrarywriter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.GetAllMediaLibraryRole](../../models/operations/getallmedialibraryrole.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Guids` | [][operations.GetAllMediaLibraryGuids](../../models/operations/getallmedialibraryguids.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Collection` | [][operations.GetAllMediaLibraryCollection](../../models/operations/getallmedialibrarycollection.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### One
|
||||
### OptimizedForStreaming1
|
||||
|
||||
```go
|
||||
getAllMediaLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryOptimizedForStreamingOne(operations.One{/* values here */})
|
||||
getAllMediaLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryOptimizedForStreamingOptimizedForStreaming1(operations.OptimizedForStreaming1{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
@@ -11,9 +11,9 @@
|
||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `Language` | **string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `HeaderCompression` | **bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `DOVIBLCompatID` | **int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
@@ -28,6 +28,7 @@
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `CodedHeight` | **int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `CodedWidth` | **int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -39,6 +40,7 @@
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `IncludeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `IncludeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsEnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `GetLibraryItemsEnableCreditsMarkerGenerationLibraryDefault` | -1 |
|
||||
| `GetLibraryItemsEnableCreditsMarkerGenerationDisabled` | 0 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsEpisodeSort
|
||||
|
||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------------------ | ------------------------------------------ |
|
||||
| `GetLibraryItemsEpisodeSortLibraryDefault` | -1 |
|
||||
| `GetLibraryItemsEpisodeSortOldestFirst` | 0 |
|
||||
| `GetLibraryItemsEpisodeSortNewestFirst` | 1 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsFlattenSeasons
|
||||
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `GetLibraryItemsFlattenSeasonsLibraryDefault` | -1 |
|
||||
| `GetLibraryItemsFlattenSeasonsHide` | 0 |
|
||||
| `GetLibraryItemsFlattenSeasonsShow` | 1 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetLibraryItemsMediaGUID
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `ID` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -23,10 +23,10 @@
|
||||
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `SeasonCount` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `FlattenSeasons` | [*operations.GetLibraryItemsFlattenSeasons](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `EpisodeSort` | [*operations.GetLibraryItemsEpisodeSort](../../models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `EnableCreditsMarkerGeneration` | [*operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `ShowOrdering` | [*operations.GetLibraryItemsShowOrdering](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||
| `FlattenSeasons` | [*operations.FlattenSeasons](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `EpisodeSort` | [*operations.EpisodeSort](../../models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `EnableCreditsMarkerGeneration` | [*operations.EnableCreditsMarkerGeneration](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `ShowOrdering` | [*operations.ShowOrdering](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `Banner` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
@@ -55,9 +55,9 @@
|
||||
| `Collection` | [][operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Location` | [][operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MediaGUID` | [][operations.GetLibraryItemsMediaGUID](../../models/operations/getlibraryitemsmediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `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/> | |
|
||||
| `UltraBlurColors` | [*operations.GetLibraryItemsUltraBlurColors](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MetaDataRating` | [][operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MetaDataRating` | [][operations.MetaDataRating](../../models/operations/metadatarating.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Image` | [][operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md) | :heavy_minus_sign: | N/A | |
|
||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryItemsMetaDataRating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `Image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `Value` | *float32* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,20 +0,0 @@
|
||||
# GetLibraryItemsShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show.
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------------- | ----------------------------------------- |
|
||||
| `GetLibraryItemsShowOrderingNone` | None |
|
||||
| `GetLibraryItemsShowOrderingTmdbAiring` | tmdbAiring |
|
||||
| `GetLibraryItemsShowOrderingTvdbAired` | aired |
|
||||
| `GetLibraryItemsShowOrderingTvdbDvd` | dvd |
|
||||
| `GetLibraryItemsShowOrderingTvdbAbsolute` | absolute |
|
||||
12
docs/models/operations/getmediaartsmediacontainer.md
Normal file
12
docs/models/operations/getmediaartsmediacontainer.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMediaArtsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `Metadata` | [][operations.GetMediaArtsMetadata](../../models/operations/getmediaartsmetadata.md) | :heavy_check_mark: | N/A | |
|
||||
12
docs/models/operations/getmediaartsmetadata.md
Normal file
12
docs/models/operations/getmediaartsmetadata.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMediaArtsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
|
||||
| `Provider` | **string* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
|
||||
| `Selected` | *bool* | :heavy_check_mark: | Whether this is the selected artwork. | true |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |
|
||||
8
docs/models/operations/getmediaartsrequest.md
Normal file
8
docs/models/operations/getmediaartsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaArtsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the artwork of. | 16099 |
|
||||
11
docs/models/operations/getmediaartsresponse.md
Normal file
11
docs/models/operations/getmediaartsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaArtsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetMediaArtsResponseBody](../../models/operations/getmediaartsresponsebody.md) | :heavy_minus_sign: | The available background artwork for the library item. |
|
||||
10
docs/models/operations/getmediaartsresponsebody.md
Normal file
10
docs/models/operations/getmediaartsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaArtsResponseBody
|
||||
|
||||
The available background artwork for the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetMediaArtsMediaContainer](../../models/operations/getmediaartsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### GetMediaMetaDataOptimizedForStreaming1
|
||||
### GetMediaMetaDataOptimizedForStreamingLibrary1
|
||||
|
||||
```go
|
||||
getMediaMetaDataLibraryOptimizedForStreaming := operations.CreateGetMediaMetaDataLibraryOptimizedForStreamingGetMediaMetaDataOptimizedForStreaming1(operations.GetMediaMetaDataOptimizedForStreaming1{/* values here */})
|
||||
getMediaMetaDataLibraryOptimizedForStreaming := operations.CreateGetMediaMetaDataLibraryOptimizedForStreamingGetMediaMetaDataOptimizedForStreamingLibrary1(operations.GetMediaMetaDataOptimizedForStreamingLibrary1{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
@@ -19,8 +19,8 @@
|
||||
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataOptimizedForStreaming](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Part` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
| `Part` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -63,6 +63,6 @@
|
||||
| `Role` | [][operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md) | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `Director` | [][operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md) | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `Writer` | [][operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md) | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `Producer` | [][operations.Producer](../../models/operations/producer.md) | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `Similar` | [][operations.Similar](../../models/operations/similar.md) | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `Producer` | [][operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md) | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `Similar` | [][operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md) | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `Location` | [][operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md) | :heavy_minus_sign: | An array of location objects. | |
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### OptimizedForStreaming1
|
||||
### GetMediaMetaDataOptimizedForStreaming1
|
||||
|
||||
```go
|
||||
getMediaMetaDataOptimizedForStreaming := operations.CreateGetMediaMetaDataOptimizedForStreamingOptimizedForStreaming1(operations.OptimizedForStreaming1{/* values here */})
|
||||
getMediaMetaDataOptimizedForStreaming := operations.CreateGetMediaMetaDataOptimizedForStreamingGetMediaMetaDataOptimizedForStreaming1(operations.GetMediaMetaDataOptimizedForStreaming1{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetMediaMetaDataOptimizedForStreamingLibrary1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `GetMediaMetaDataOptimizedForStreamingLibrary1Zero` | 0 |
|
||||
| `GetMediaMetaDataOptimizedForStreamingLibrary1One` | 1 |
|
||||
13
docs/models/operations/getmediametadataproducer.md
Normal file
13
docs/models/operations/getmediametadataproducer.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataProducer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `TagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `Role` | **string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
10
docs/models/operations/getmediametadatasimilar.md
Normal file
10
docs/models/operations/getmediametadatasimilar.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataSimilar
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
@@ -11,9 +11,9 @@
|
||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `Language` | **string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `HeaderCompression` | **bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `DOVIBLCompatID` | **int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
@@ -28,6 +28,7 @@
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `CodedHeight` | **int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `CodedWidth` | **int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -39,6 +40,7 @@
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
|
||||
12
docs/models/operations/getmediapostersmediacontainer.md
Normal file
12
docs/models/operations/getmediapostersmediacontainer.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMediaPostersMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `Metadata` | [][operations.GetMediaPostersMetadata](../../models/operations/getmediapostersmetadata.md) | :heavy_check_mark: | N/A | |
|
||||
12
docs/models/operations/getmediapostersmetadata.md
Normal file
12
docs/models/operations/getmediapostersmetadata.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMediaPostersMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Key` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||
| `Provider` | **string* | :heavy_minus_sign: | The provider of the poster. | tmdb |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||
| `Selected` | *bool* | :heavy_check_mark: | Whether this is the selected poster. | true |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |
|
||||
8
docs/models/operations/getmediapostersrequest.md
Normal file
8
docs/models/operations/getmediapostersrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaPostersRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 16099 |
|
||||
11
docs/models/operations/getmediapostersresponse.md
Normal file
11
docs/models/operations/getmediapostersresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaPostersResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetMediaPostersResponseBody](../../models/operations/getmediapostersresponsebody.md) | :heavy_minus_sign: | The available posters for the library item. |
|
||||
10
docs/models/operations/getmediapostersresponsebody.md
Normal file
10
docs/models/operations/getmediapostersresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaPostersResponseBody
|
||||
|
||||
The available posters for the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetMediaPostersMediaContainer](../../models/operations/getmediapostersmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetOnDeckGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `ID` | **string* | :heavy_minus_sign: | N/A | imdb://tt13303712 |
|
||||
@@ -1,22 +0,0 @@
|
||||
# GetOnDeckMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `ID` | **float64* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 1046 |
|
||||
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `Height` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.78 |
|
||||
| `AudioChannels` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | PAL |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main |
|
||||
| `Part` | [][operations.GetOnDeckPart](../../models/operations/getondeckpart.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,14 +0,0 @@
|
||||
# GetOnDeckMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `Size` | **float64* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `Metadata` | [][operations.GetOnDeckMetadata](../../models/operations/getondeckmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,43 +0,0 @@
|
||||
# GetOnDeckMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `LibrarySectionID` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
||||
| `RatingKey` | **float64* | :heavy_minus_sign: | N/A | 49564 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
|
||||
| `ParentRatingKey` | **float64* | :heavy_minus_sign: | N/A | 49557 |
|
||||
| `GrandparentRatingKey` | **float64* | :heavy_minus_sign: | N/A | 49556 |
|
||||
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
|
||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
|
||||
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | episode |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Circus |
|
||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
|
||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
|
||||
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/2 |
|
||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Bluey (2018) |
|
||||
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | TV-Y |
|
||||
| `Summary` | **string* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
|
||||
| `Index` | **float64* | :heavy_minus_sign: | N/A | 33 |
|
||||
| `ParentIndex` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `LastViewedAt` | **float64* | :heavy_minus_sign: | N/A | 1681908352 |
|
||||
| `Year` | **float64* | :heavy_minus_sign: | N/A | 2018 |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
|
||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
|
||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `OriginallyAvailableAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
|
||||
| `AddedAt` | **float64* | :heavy_minus_sign: | N/A | 1654258196 |
|
||||
| `UpdatedAt` | **float64* | :heavy_minus_sign: | N/A | 1654258204 |
|
||||
| `Media` | [][operations.GetOnDeckMedia](../../models/operations/getondeckmedia.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Guids` | [][operations.GetOnDeckGuids](../../models/operations/getondeckguids.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetOnDeckPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `ID` | **float64* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `File` | **string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||
| `Size` | **float64* | :heavy_minus_sign: | N/A | 55148931 |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main |
|
||||
| `Stream` | [][operations.GetOnDeckStream](../../models/operations/getondeckstream.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetOnDeckResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetOnDeckResponseBody](../../models/operations/getondeckresponsebody.md) | :heavy_minus_sign: | The on Deck content |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetOnDeckResponseBody
|
||||
|
||||
The on Deck content
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetOnDeckMediaContainer](../../models/operations/getondeckmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,30 +0,0 @@
|
||||
# GetOnDeckStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `ID` | **float64* | :heavy_minus_sign: | N/A | 211234 |
|
||||
| `StreamType` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Default` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `Codec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `Index` | **float64* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 918 |
|
||||
| `Language` | **string* | :heavy_minus_sign: | N/A | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | N/A | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | N/A | eng |
|
||||
| `BitDepth` | **float64* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | N/A | left |
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | N/A | 4:2:0 |
|
||||
| `CodedHeight` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `CodedWidth` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | N/A | tv |
|
||||
| `FrameRate` | **float64* | :heavy_minus_sign: | N/A | 25 |
|
||||
| `Height` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `Level` | **float64* | :heavy_minus_sign: | N/A | 120 |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | N/A | main |
|
||||
| `RefFrames` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
||||
@@ -5,10 +5,10 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `Size` | *int64* | :heavy_check_mark: | N/A | 50 |
|
||||
| `Offset` | **int* | :heavy_minus_sign: | N/A | |
|
||||
| `TotalSize` | **int* | :heavy_minus_sign: | N/A | |
|
||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `TotalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `Offset` | *int64* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `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/> | |
|
||||
| `Metadata` | [][operations.GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Metadata` | [][operations.GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md) | :heavy_minus_sign: | An array of metadata items. | |
|
||||
@@ -1,83 +1,85 @@
|
||||
# GetRecentlyAddedMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `Key` | *string* | :heavy_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 |
|
||||
| `SkipChildren` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `Type` | [operations.GetRecentlyAddedHubsType](../../models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `Slug` | **string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `Summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `SeasonCount` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `FlattenSeasons` | [*operations.FlattenSeasons](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `EpisodeSort` | [*operations.EpisodeSort](../../models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `EnableCreditsMarkerGeneration` | [*operations.EnableCreditsMarkerGeneration](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `ShowOrdering` | [*operations.ShowOrdering](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `Banner` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `AddedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `ParentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `GrandparentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `Media` | [][operations.Media](../../models/operations/media.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `Genre` | [][operations.Genre](../../models/operations/genre.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | [][operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Director` | [][operations.Director](../../models/operations/director.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.Writer](../../models/operations/writer.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Collection` | [][operations.Collection](../../models/operations/collection.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.Role](../../models/operations/role.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Location` | [][operations.Location](../../models/operations/location.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/> | |
|
||||
| `UltraBlurColors` | [*operations.UltraBlurColors](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MetaDataRating` | [][operations.MetaDataRating](../../models/operations/metadatarating.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Image` | [][operations.GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md) | :heavy_minus_sign: | N/A | |
|
||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `OriginalTitle` | **string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `ViewOffset` | **int* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `SkipCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Index` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Theme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `LeafCount` | **int* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `ParentIndex` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ParentYear` | **int* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `ParentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `Art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `AudienceRating` | *float64* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `ChapterSource` | **string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `ChildCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `ContentRating` | **string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `CreatedAtAccuracy` | **string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||
| `CreatedAtTZOffset` | **string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `Duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `GrandparentGUID` | **string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `GrandparentSlug` | **string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `GUID` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `Index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `Key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `LeafCount` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `OriginallyAvailableAt` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `ParentSlug` | **string* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
|
||||
| `ParentStudio` | *string* | :heavy_check_mark: | The studio of the parent media item. | UCP |
|
||||
| `ParentTheme` | *string* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `ParentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `ParentYear` | **int* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `RatingImage` | **string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `Rating` | *float32* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `SeasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `SkipCount` | **int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `Slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `Studio` | **string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `Subtype` | **string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||
| `Summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `Theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `TitleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `Type` | [operations.GetRecentlyAddedHubsType](../../models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `ViewOffset` | **int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `Year` | **int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `Image` | [][operations.GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md) | :heavy_minus_sign: | N/A | |
|
||||
| `UltraBlurColors` | [*operations.UltraBlurColors](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Media` | [][operations.Media](../../models/operations/media.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Genre` | [][operations.Genre](../../models/operations/genre.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | [][operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Director` | [][operations.Director](../../models/operations/director.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.Writer](../../models/operations/writer.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.Role](../../models/operations/role.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Producer` | [][operations.Producer](../../models/operations/producer.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Rating1` | [][operations.Rating](../../models/operations/rating.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Similar` | [][operations.Similar](../../models/operations/similar.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Collection` | [][operations.Collection](../../models/operations/collection.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetRecentlyAddedOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### GetRecentlyAddedOptimizedForStreaming1
|
||||
|
||||
```go
|
||||
getRecentlyAddedOptimizedForStreaming := operations.CreateGetRecentlyAddedOptimizedForStreamingGetRecentlyAddedOptimizedForStreaming1(operations.GetRecentlyAddedOptimizedForStreaming1{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
```go
|
||||
getRecentlyAddedOptimizedForStreaming := operations.CreateGetRecentlyAddedOptimizedForStreamingBoolean(bool{/* values here */})
|
||||
```
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetRecentlyAddedOptimizedForStreaming1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------------------------- | -------------------------------------------- |
|
||||
| `GetRecentlyAddedOptimizedForStreaming1Zero` | 0 |
|
||||
| `GetRecentlyAddedOptimizedForStreaming1One` | 1 |
|
||||
@@ -1,5 +1,7 @@
|
||||
# HasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
|
||||
11
docs/models/operations/hidden.md
Normal file
11
docs/models/operations/hidden.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Hidden
|
||||
|
||||
UNKNOWN
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `HiddenDisable` | 0 |
|
||||
| `HiddenEnable` | 1 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# IncludeDetails
|
||||
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Level
|
||||
|
||||
An integer log level to write to the PMS log with.
|
||||
0: Error
|
||||
1: Warning
|
||||
2: Info
|
||||
3: Debug
|
||||
An integer log level to write to the PMS log with.
|
||||
0: Error
|
||||
1: Warning
|
||||
2: Info
|
||||
3: Debug
|
||||
4: Verbose
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
# Location
|
||||
|
||||
The folder path for the media item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `Path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `Level` | [operations.Level](../../models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with. <br/>0: Error <br/>1: Warning <br/>2: Info <br/>3: Debug <br/>4: Verbose<br/> | |
|
||||
| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `Level` | [operations.Level](../../models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.<br/>0: Error<br/>1: Warning<br/>2: Info<br/>3: Debug<br/>4: Verbose<br/> | |
|
||||
| `Message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `Source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
@@ -5,21 +5,22 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | [*operations.OptimizedForStreaming](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `Height` | **int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `OptimizedForStreaming` | [*operations.OptimizedForStreaming](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Part` | [][operations.Part](../../models/operations/part.md) | :heavy_check_mark: | N/A | |
|
||||
| `Part` | [][operations.Part](../../models/operations/part.md) | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -1,9 +1,19 @@
|
||||
# OptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------ | ------------------------------ |
|
||||
| `OptimizedForStreamingDisable` | 0 |
|
||||
| `OptimizedForStreamingEnable` | 1 |
|
||||
## Supported Types
|
||||
|
||||
### One
|
||||
|
||||
```go
|
||||
optimizedForStreaming := operations.CreateOptimizedForStreamingOne(operations.One{/* values here */})
|
||||
```
|
||||
|
||||
###
|
||||
|
||||
```go
|
||||
optimizedForStreaming := operations.CreateOptimizedForStreamingBoolean(bool{/* values here */})
|
||||
```
|
||||
|
||||
|
||||
@@ -3,18 +3,21 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `Size` | *int64* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `HasThumbnail` | [*operations.HasThumbnail](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `Size` | *int64* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | [*operations.GetRecentlyAddedOptimizedForStreaming](../../models/operations/getrecentlyaddedoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `HasThumbnail` | [*operations.HasThumbnail](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
10
docs/models/operations/postmediaartsrequest.md
Normal file
10
docs/models/operations/postmediaartsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PostMediaArtsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||
| `URL` | **string* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||
| `RequestBody` | **any* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||
10
docs/models/operations/postmediaartsresponse.md
Normal file
10
docs/models/operations/postmediaartsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PostMediaArtsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/operations/postmediaposterrequest.md
Normal file
10
docs/models/operations/postmediaposterrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PostMediaPosterRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||
| `URL` | **string* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||
| `RequestBody` | **any* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||
10
docs/models/operations/postmediaposterresponse.md
Normal file
10
docs/models/operations/postmediaposterresponse.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PostMediaPosterResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,11 +3,10 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `TagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `Role` | **string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
|
||||
| `TagKey` | **string* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
@@ -1,8 +1,8 @@
|
||||
# QueryParamForce
|
||||
|
||||
Force overwriting of duplicate playlists.
|
||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
The `force` argument is used to disable overwriting.
|
||||
Force overwriting of duplicate playlists.
|
||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
The `force` argument is used to disable overwriting.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
12
docs/models/operations/rating.md
Normal file
12
docs/models/operations/rating.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Rating
|
||||
|
||||
The type of rating, for example 'audience' or 'critic'.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `Image` | *string* | :heavy_check_mark: | N/A | imdb://image.rating |
|
||||
| `Value` | *float64* | :heavy_check_mark: | N/A | 5.1 |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | audience |
|
||||
@@ -3,11 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `ID` | **int64* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `Filter` | **string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `TagKey` | **string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `Role` | **string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `TagKey` | **string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `Role` | **string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
@@ -1,10 +1,12 @@
|
||||
# Similar
|
||||
|
||||
The display tag for the similar item, typically the title.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 259 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | N/A | similar=259 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |
|
||||
@@ -3,43 +3,54 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `StreamType` | *int64* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `Index` | *int64* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `Bitrate` | **int64* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `ColorTrc` | **string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `BitDepth` | **int64* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `StreamIdentifier` | **string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `CodedHeight` | **int64* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `CodedWidth` | **int64* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `FrameRate` | **float64* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Height` | **int64* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `Level` | **int64* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `Width` | **int64* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `Language` | **string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `Title` | **string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `StreamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `Language` | **string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `HeaderCompression` | **bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `DOVIBLCompatID` | **int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `DOVIELPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `DOVILevel` | **int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `DOVIPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `DOVIProfile` | **int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `DOVIRPUPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `DOVIVersion` | **string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `BitDepth` | **int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `CodedHeight` | **int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `CodedWidth` | **int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `ColorTrc` | **string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `FrameRate` | **float32* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `Height` | **int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `Level` | **int* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `Original` | **bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Channels` | **int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `SamplingRate` | **int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `Dub` | **bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `Title` | **string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| 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/> | |
|
||||
| `SectionID` | *int64* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
| 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/> | |
|
||||
| `SectionID` | *int64* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
@@ -3,6 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `ID` | *int64* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
|
||||
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `TagKey` | **string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `Errors` | [][sdkerrors.GetOnDeckErrors](../../models/sdkerrors/getondeckerrors.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 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetOnDeckErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `Code` | **int* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `Message` | **string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `Status` | **int* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetOnDeckLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `Code` | **int* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `Message` | **string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `Status` | **int* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetOnDeckUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `Errors` | [][sdkerrors.GetOnDeckLibraryErrors](../../models/sdkerrors/getondecklibraryerrors.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 |
|
||||
@@ -22,9 +22,12 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [GetActorsLibrary](#getactorslibrary) - Get Actors of library media
|
||||
* [GetSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
|
||||
* [GetMediaMetaData](#getmediametadata) - Get Media Metadata
|
||||
* [GetMediaArts](#getmediaarts) - Get Media Background Artwork
|
||||
* [PostMediaArts](#postmediaarts) - Upload Media Background Artwork
|
||||
* [GetMediaPosters](#getmediaposters) - Get Media Posters
|
||||
* [PostMediaPoster](#postmediaposter) - Upload Media Poster
|
||||
* [GetMetadataChildren](#getmetadatachildren) - Get Items Children
|
||||
* [GetTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [GetOnDeck](#getondeck) - Get On Deck
|
||||
|
||||
## GetFileHash
|
||||
|
||||
@@ -212,14 +215,14 @@ func main() {
|
||||
|
||||
## Library Details Endpoint
|
||||
|
||||
This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
|
||||
The details include:
|
||||
|
||||
### Directories
|
||||
Organized into three categories:
|
||||
|
||||
- **Primary Directories**:
|
||||
- **Primary Directories**:
|
||||
- Used in some clients for quick access to media subsets (e.g., "All", "On Deck").
|
||||
- Most can be replicated via media queries.
|
||||
- Customizable by users.
|
||||
@@ -281,12 +284,12 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -908,6 +911,210 @@ func main() {
|
||||
| sdkerrors.GetMediaMetaDataUnauthorized | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMediaArts
|
||||
|
||||
Returns the background artwork for a library item.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetMediaArts(ctx, 16099)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `ratingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the artwork of. | 16099 |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetMediaArtsResponse](../../models/operations/getmediaartsresponse.md), error**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------ | ------------------ | ------------------ |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## PostMediaArts
|
||||
|
||||
Uploads an image to use as the background artwork for a library item, either from a local file or a remote URL
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.PostMediaArts(ctx, 2268, plexgo.String("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"), nil)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `ratingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||
| `url_` | **string* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||
| `requestBody` | **any* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.PostMediaArtsResponse](../../models/operations/postmediaartsresponse.md), error**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------ | ------------------ | ------------------ |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMediaPosters
|
||||
|
||||
Returns the available posters for a library item.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetMediaPosters(ctx, 16099)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `ratingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 16099 |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetMediaPostersResponse](../../models/operations/getmediapostersresponse.md), error**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------ | ------------------ | ------------------ |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## PostMediaPoster
|
||||
|
||||
Uploads a poster to a library item, either from a local file or a remote URL
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.PostMediaPoster(ctx, 2268, plexgo.String("https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b"), nil)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `ratingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the posters of. | 2268 |
|
||||
| `url_` | **string* | :heavy_minus_sign: | The URL of the image, if uploading a remote image | https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b |
|
||||
| `requestBody` | **any* | :heavy_minus_sign: | The contents of the image, if uploading a local file | |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.PostMediaPosterResponse](../../models/operations/postmediaposterresponse.md), error**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------ | ------------------ | ------------------ |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMetadataChildren
|
||||
|
||||
This endpoint will return the children of of a library item specified with the ratingKey.
|
||||
@@ -1015,56 +1222,4 @@ func main() {
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| sdkerrors.GetTopWatchedContentBadRequest | 400 | application/json |
|
||||
| sdkerrors.GetTopWatchedContentUnauthorized | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetOnDeck
|
||||
|
||||
This endpoint will return the on deck content.
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import(
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
res, err := s.Library.GetOnDeck(ctx)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. |
|
||||
|
||||
### Response
|
||||
|
||||
**[*operations.GetOnDeckResponse](../../models/operations/getondeckresponse.md), error**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| sdkerrors.GetOnDeckBadRequest | 400 | application/json |
|
||||
| sdkerrors.GetOnDeckUnauthorized | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
@@ -48,13 +48,13 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `level` | [operations.Level](../../models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with. <br/>0: Error <br/>1: Warning <br/>2: Info <br/>3: Debug <br/>4: Verbose<br/> | |
|
||||
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `level` | [operations.Level](../../models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.<br/>0: Error<br/>1: Warning<br/>2: Info<br/>3: Debug<br/>4: Verbose<br/> | |
|
||||
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -70,13 +70,13 @@ func main() {
|
||||
|
||||
## LogMultiLine
|
||||
|
||||
This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
|
||||
Log entries are separated by a newline character (`\n`).
|
||||
Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
Log entries are separated by a newline character (`\n`).
|
||||
Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
|
||||
The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
||||
- `0`: Error - Critical issues that require immediate attention.
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
||||
Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017").
|
||||
They can be organized in (optionally nesting) folders.
|
||||
Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
Retrieving a playlist, or its items, will trigger a refresh of its metadata.
|
||||
This may cause the duration and number of items to change.
|
||||
|
||||
|
||||
@@ -500,13 +500,13 @@ func main() {
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `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/> | |
|
||||
| `sectionID` | *int64* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
|
||||
| `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/> | |
|
||||
| `sectionID` | *int64* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -186,8 +186,8 @@ func UnmarshalJSON(b []byte, v interface{}, tag reflect.StructTag, topLevel bool
|
||||
|
||||
value, ok := unmarhsaled[fieldName]
|
||||
if !ok {
|
||||
defaultTag := field.Tag.Get("default")
|
||||
if defaultTag != "" {
|
||||
defaultTag, defaultOk := field.Tag.Lookup("default")
|
||||
if defaultOk {
|
||||
value = handleDefaultConstValue(defaultTag, fieldVal.Interface(), field.Tag)
|
||||
ok = true
|
||||
}
|
||||
@@ -257,8 +257,8 @@ func marshalValue(v interface{}, tag reflect.StructTag) (json.RawMessage, error)
|
||||
}
|
||||
|
||||
if isNil(reflect.TypeOf(v), reflect.ValueOf(v)) {
|
||||
defaultTag := tag.Get("default")
|
||||
if defaultTag != "" {
|
||||
defaultTag, ok := tag.Lookup("default")
|
||||
if ok {
|
||||
return handleDefaultConstValue(defaultTag, v, tag), nil
|
||||
}
|
||||
|
||||
|
||||
1059
library.go
1059
library.go
File diff suppressed because it is too large
Load Diff
@@ -20,23 +20,6 @@ const (
|
||||
func (e CreatePlaylistQueryParamType) ToPointer() *CreatePlaylistQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *CreatePlaylistQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "audio":
|
||||
fallthrough
|
||||
case "video":
|
||||
fallthrough
|
||||
case "photo":
|
||||
*e = CreatePlaylistQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for CreatePlaylistQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// Smart - whether the playlist is smart or not
|
||||
type Smart int64
|
||||
|
||||
@@ -3,8 +3,6 @@
|
||||
package operations
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
@@ -29,31 +27,6 @@ const (
|
||||
func (e GetActorsLibraryQueryParamType) ToPointer() *GetActorsLibraryQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetActorsLibraryQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v int64
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 1:
|
||||
fallthrough
|
||||
case 2:
|
||||
fallthrough
|
||||
case 3:
|
||||
fallthrough
|
||||
case 4:
|
||||
fallthrough
|
||||
case 8:
|
||||
fallthrough
|
||||
case 9:
|
||||
fallthrough
|
||||
case 10:
|
||||
*e = GetActorsLibraryQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetActorsLibraryQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetActorsLibraryRequest struct {
|
||||
// The unique key of the Plex library.
|
||||
|
||||
@@ -3,11 +3,59 @@
|
||||
package operations
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"github.com/LukeHagar/plexgo/internal/utils"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// GetAllLibrariesType - The library type
|
||||
type GetAllLibrariesType string
|
||||
|
||||
const (
|
||||
GetAllLibrariesTypeMovie GetAllLibrariesType = "movie"
|
||||
GetAllLibrariesTypeTvShow GetAllLibrariesType = "show"
|
||||
GetAllLibrariesTypeSeason GetAllLibrariesType = "season"
|
||||
GetAllLibrariesTypeEpisode GetAllLibrariesType = "episode"
|
||||
GetAllLibrariesTypeArtist GetAllLibrariesType = "artist"
|
||||
GetAllLibrariesTypeAlbum GetAllLibrariesType = "album"
|
||||
)
|
||||
|
||||
func (e GetAllLibrariesType) ToPointer() *GetAllLibrariesType {
|
||||
return &e
|
||||
}
|
||||
|
||||
// Hidden - UNKNOWN
|
||||
type Hidden int
|
||||
|
||||
const (
|
||||
HiddenDisable Hidden = 0
|
||||
HiddenEnable Hidden = 1
|
||||
)
|
||||
|
||||
func (e Hidden) ToPointer() *Hidden {
|
||||
return &e
|
||||
}
|
||||
func (e *Hidden) UnmarshalJSON(data []byte) error {
|
||||
var v int
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 0:
|
||||
fallthrough
|
||||
case 1:
|
||||
*e = Hidden(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for Hidden: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetAllLibrariesLocation struct {
|
||||
ID int `json:"id"`
|
||||
// The ID of the location.
|
||||
ID int `json:"id"`
|
||||
// The path to the media item.
|
||||
Path string `json:"path"`
|
||||
}
|
||||
|
||||
@@ -26,33 +74,59 @@ func (o *GetAllLibrariesLocation) GetPath() string {
|
||||
}
|
||||
|
||||
type GetAllLibrariesDirectory struct {
|
||||
AllowSync bool `json:"allowSync"`
|
||||
Art string `json:"art"`
|
||||
Composite string `json:"composite"`
|
||||
Filters bool `json:"filters"`
|
||||
Refreshing bool `json:"refreshing"`
|
||||
Thumb string `json:"thumb"`
|
||||
Key string `json:"key"`
|
||||
Type string `json:"type"`
|
||||
Title string `json:"title"`
|
||||
Agent string `json:"agent"`
|
||||
Scanner string `json:"scanner"`
|
||||
Language string `json:"language"`
|
||||
UUID string `json:"uuid"`
|
||||
// Indicates whether syncing is allowed.
|
||||
AllowSync bool `json:"allowSync"`
|
||||
// URL for the background artwork of the media container.
|
||||
Art string `json:"art"`
|
||||
// The relative path to the composite media item.
|
||||
Composite string `json:"composite"`
|
||||
// UNKNOWN
|
||||
Filters bool `json:"filters"`
|
||||
// Indicates whether the library is currently being refreshed or updated
|
||||
Refreshing bool `json:"refreshing"`
|
||||
// URL for the thumbnail image of the media container.
|
||||
Thumb string `json:"thumb"`
|
||||
// The library key representing the unique identifier
|
||||
Key string `json:"key"`
|
||||
Type GetAllLibrariesType `json:"type"`
|
||||
// The title of the library
|
||||
Title string `json:"title"`
|
||||
// The Plex agent used to match and retrieve media metadata.
|
||||
Agent string `json:"agent"`
|
||||
// UNKNOWN
|
||||
Scanner string `json:"scanner"`
|
||||
// The Plex library language that has been set
|
||||
Language string `json:"language"`
|
||||
// The universally unique identifier for the library.
|
||||
UUID string `json:"uuid"`
|
||||
// Unix epoch datetime in seconds
|
||||
UpdatedAt int64 `json:"updatedAt"`
|
||||
// Unix epoch datetime in seconds
|
||||
CreatedAt int64 `json:"createdAt"`
|
||||
UpdatedAt int64 `json:"updatedAt"`
|
||||
CreatedAt *int64 `json:"createdAt,omitempty"`
|
||||
// Unix epoch datetime in seconds
|
||||
ScannedAt int64 `json:"scannedAt"`
|
||||
Content bool `json:"content"`
|
||||
Directory bool `json:"directory"`
|
||||
// Unix epoch datetime in seconds
|
||||
// UNKNOWN
|
||||
Content bool `json:"content"`
|
||||
// UNKNOWN
|
||||
Directory bool `json:"directory"`
|
||||
// Timestamp (in seconds) representing the last time the content was modified.
|
||||
// NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64
|
||||
//
|
||||
ContentChangedAt int64 `json:"contentChangedAt"`
|
||||
Hidden int `json:"hidden"`
|
||||
Hidden *Hidden `default:"0" json:"hidden"`
|
||||
Location []GetAllLibrariesLocation `json:"Location"`
|
||||
}
|
||||
|
||||
func (g GetAllLibrariesDirectory) MarshalJSON() ([]byte, error) {
|
||||
return utils.MarshalJSON(g, "", false)
|
||||
}
|
||||
|
||||
func (g *GetAllLibrariesDirectory) UnmarshalJSON(data []byte) error {
|
||||
if err := utils.UnmarshalJSON(data, &g, "", false, false); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesDirectory) GetAllowSync() bool {
|
||||
if o == nil {
|
||||
return false
|
||||
@@ -102,9 +176,9 @@ func (o *GetAllLibrariesDirectory) GetKey() string {
|
||||
return o.Key
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesDirectory) GetType() string {
|
||||
func (o *GetAllLibrariesDirectory) GetType() GetAllLibrariesType {
|
||||
if o == nil {
|
||||
return ""
|
||||
return GetAllLibrariesType("")
|
||||
}
|
||||
return o.Type
|
||||
}
|
||||
@@ -151,9 +225,9 @@ func (o *GetAllLibrariesDirectory) GetUpdatedAt() int64 {
|
||||
return o.UpdatedAt
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesDirectory) GetCreatedAt() int64 {
|
||||
func (o *GetAllLibrariesDirectory) GetCreatedAt() *int64 {
|
||||
if o == nil {
|
||||
return 0
|
||||
return nil
|
||||
}
|
||||
return o.CreatedAt
|
||||
}
|
||||
@@ -186,9 +260,9 @@ func (o *GetAllLibrariesDirectory) GetContentChangedAt() int64 {
|
||||
return o.ContentChangedAt
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesDirectory) GetHidden() int {
|
||||
func (o *GetAllLibrariesDirectory) GetHidden() *Hidden {
|
||||
if o == nil {
|
||||
return 0
|
||||
return nil
|
||||
}
|
||||
return o.Hidden
|
||||
}
|
||||
@@ -201,10 +275,13 @@ func (o *GetAllLibrariesDirectory) GetLocation() []GetAllLibrariesLocation {
|
||||
}
|
||||
|
||||
type GetAllLibrariesMediaContainer struct {
|
||||
Size int `json:"size"`
|
||||
AllowSync bool `json:"allowSync"`
|
||||
// Number of media items returned in this response.
|
||||
Size int `json:"size"`
|
||||
// Indicates whether syncing is allowed.
|
||||
AllowSync bool `json:"allowSync"`
|
||||
// The primary title of the media container.
|
||||
Title1 string `json:"title1"`
|
||||
Directory []GetAllLibrariesDirectory `json:"Directory"`
|
||||
Directory []GetAllLibrariesDirectory `json:"Directory,omitempty"`
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesMediaContainer) GetSize() int {
|
||||
@@ -230,19 +307,19 @@ func (o *GetAllLibrariesMediaContainer) GetTitle1() string {
|
||||
|
||||
func (o *GetAllLibrariesMediaContainer) GetDirectory() []GetAllLibrariesDirectory {
|
||||
if o == nil {
|
||||
return []GetAllLibrariesDirectory{}
|
||||
return nil
|
||||
}
|
||||
return o.Directory
|
||||
}
|
||||
|
||||
// GetAllLibrariesResponseBody - The libraries available on the Server
|
||||
type GetAllLibrariesResponseBody struct {
|
||||
MediaContainer GetAllLibrariesMediaContainer `json:"MediaContainer"`
|
||||
MediaContainer *GetAllLibrariesMediaContainer `json:"MediaContainer,omitempty"`
|
||||
}
|
||||
|
||||
func (o *GetAllLibrariesResponseBody) GetMediaContainer() GetAllLibrariesMediaContainer {
|
||||
func (o *GetAllLibrariesResponseBody) GetMediaContainer() *GetAllLibrariesMediaContainer {
|
||||
if o == nil {
|
||||
return GetAllLibrariesMediaContainer{}
|
||||
return nil
|
||||
}
|
||||
return o.MediaContainer
|
||||
}
|
||||
|
||||
@@ -32,31 +32,6 @@ const (
|
||||
func (e GetAllMediaLibraryQueryParamType) ToPointer() *GetAllMediaLibraryQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetAllMediaLibraryQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v int64
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 1:
|
||||
fallthrough
|
||||
case 2:
|
||||
fallthrough
|
||||
case 3:
|
||||
fallthrough
|
||||
case 4:
|
||||
fallthrough
|
||||
case 8:
|
||||
fallthrough
|
||||
case 9:
|
||||
fallthrough
|
||||
case 10:
|
||||
*e = GetAllMediaLibraryQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetAllMediaLibraryQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetAllMediaLibraryQueryParamIncludeMeta - Adds the Meta object to the response
|
||||
type GetAllMediaLibraryQueryParamIncludeMeta int
|
||||
@@ -660,29 +635,6 @@ const (
|
||||
func (e GetAllMediaLibraryLibraryType) ToPointer() *GetAllMediaLibraryLibraryType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetAllMediaLibraryLibraryType) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "movie":
|
||||
fallthrough
|
||||
case "show":
|
||||
fallthrough
|
||||
case "season":
|
||||
fallthrough
|
||||
case "episode":
|
||||
fallthrough
|
||||
case "artist":
|
||||
fallthrough
|
||||
case "album":
|
||||
*e = GetAllMediaLibraryLibraryType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetAllMediaLibraryLibraryType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetAllMediaLibraryLibraryResponseType string
|
||||
|
||||
@@ -696,25 +648,6 @@ const (
|
||||
func (e GetAllMediaLibraryLibraryResponseType) ToPointer() *GetAllMediaLibraryLibraryResponseType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetAllMediaLibraryLibraryResponseType) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "coverPoster":
|
||||
fallthrough
|
||||
case "background":
|
||||
fallthrough
|
||||
case "snapshot":
|
||||
fallthrough
|
||||
case "clearLogo":
|
||||
*e = GetAllMediaLibraryLibraryResponseType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetAllMediaLibraryLibraryResponseType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetAllMediaLibraryImage struct {
|
||||
Alt string `json:"alt"`
|
||||
@@ -778,17 +711,17 @@ func (o *GetAllMediaLibraryUltraBlurColors) GetBottomLeft() string {
|
||||
return o.BottomLeft
|
||||
}
|
||||
|
||||
type One int
|
||||
type OptimizedForStreaming1 int
|
||||
|
||||
const (
|
||||
OneZero One = 0
|
||||
OneOne One = 1
|
||||
OptimizedForStreaming1Zero OptimizedForStreaming1 = 0
|
||||
OptimizedForStreaming1One OptimizedForStreaming1 = 1
|
||||
)
|
||||
|
||||
func (e One) ToPointer() *One {
|
||||
func (e OptimizedForStreaming1) ToPointer() *OptimizedForStreaming1 {
|
||||
return &e
|
||||
}
|
||||
func (e *One) UnmarshalJSON(data []byte) error {
|
||||
func (e *OptimizedForStreaming1) UnmarshalJSON(data []byte) error {
|
||||
var v int
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
@@ -797,34 +730,34 @@ func (e *One) UnmarshalJSON(data []byte) error {
|
||||
case 0:
|
||||
fallthrough
|
||||
case 1:
|
||||
*e = One(v)
|
||||
*e = OptimizedForStreaming1(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for One: %v", v)
|
||||
return fmt.Errorf("invalid value for OptimizedForStreaming1: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetAllMediaLibraryOptimizedForStreamingType string
|
||||
|
||||
const (
|
||||
GetAllMediaLibraryOptimizedForStreamingTypeOne GetAllMediaLibraryOptimizedForStreamingType = "1"
|
||||
GetAllMediaLibraryOptimizedForStreamingTypeBoolean GetAllMediaLibraryOptimizedForStreamingType = "boolean"
|
||||
GetAllMediaLibraryOptimizedForStreamingTypeOptimizedForStreaming1 GetAllMediaLibraryOptimizedForStreamingType = "optimizedForStreaming_1"
|
||||
GetAllMediaLibraryOptimizedForStreamingTypeBoolean GetAllMediaLibraryOptimizedForStreamingType = "boolean"
|
||||
)
|
||||
|
||||
// GetAllMediaLibraryOptimizedForStreaming - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
type GetAllMediaLibraryOptimizedForStreaming struct {
|
||||
One *One `queryParam:"inline"`
|
||||
Boolean *bool `queryParam:"inline"`
|
||||
OptimizedForStreaming1 *OptimizedForStreaming1 `queryParam:"inline"`
|
||||
Boolean *bool `queryParam:"inline"`
|
||||
|
||||
Type GetAllMediaLibraryOptimizedForStreamingType
|
||||
}
|
||||
|
||||
func CreateGetAllMediaLibraryOptimizedForStreamingOne(one One) GetAllMediaLibraryOptimizedForStreaming {
|
||||
typ := GetAllMediaLibraryOptimizedForStreamingTypeOne
|
||||
func CreateGetAllMediaLibraryOptimizedForStreamingOptimizedForStreaming1(optimizedForStreaming1 OptimizedForStreaming1) GetAllMediaLibraryOptimizedForStreaming {
|
||||
typ := GetAllMediaLibraryOptimizedForStreamingTypeOptimizedForStreaming1
|
||||
|
||||
return GetAllMediaLibraryOptimizedForStreaming{
|
||||
One: &one,
|
||||
Type: typ,
|
||||
OptimizedForStreaming1: &optimizedForStreaming1,
|
||||
Type: typ,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -839,10 +772,10 @@ func CreateGetAllMediaLibraryOptimizedForStreamingBoolean(boolean bool) GetAllMe
|
||||
|
||||
func (u *GetAllMediaLibraryOptimizedForStreaming) UnmarshalJSON(data []byte) error {
|
||||
|
||||
var one One = One(0)
|
||||
if err := utils.UnmarshalJSON(data, &one, "", true, true); err == nil {
|
||||
u.One = &one
|
||||
u.Type = GetAllMediaLibraryOptimizedForStreamingTypeOne
|
||||
var optimizedForStreaming1 OptimizedForStreaming1 = OptimizedForStreaming1(0)
|
||||
if err := utils.UnmarshalJSON(data, &optimizedForStreaming1, "", true, true); err == nil {
|
||||
u.OptimizedForStreaming1 = &optimizedForStreaming1
|
||||
u.Type = GetAllMediaLibraryOptimizedForStreamingTypeOptimizedForStreaming1
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -857,8 +790,8 @@ func (u *GetAllMediaLibraryOptimizedForStreaming) UnmarshalJSON(data []byte) err
|
||||
}
|
||||
|
||||
func (u GetAllMediaLibraryOptimizedForStreaming) MarshalJSON() ([]byte, error) {
|
||||
if u.One != nil {
|
||||
return utils.MarshalJSON(u.One, "", true)
|
||||
if u.OptimizedForStreaming1 != nil {
|
||||
return utils.MarshalJSON(u.OptimizedForStreaming1, "", true)
|
||||
}
|
||||
|
||||
if u.Boolean != nil {
|
||||
@@ -999,11 +932,11 @@ type GetAllMediaLibraryStream struct {
|
||||
// Bitrate of the stream.
|
||||
Bitrate *int `json:"bitrate,omitempty"`
|
||||
// Language of the stream.
|
||||
Language string `json:"language"`
|
||||
Language *string `json:"language,omitempty"`
|
||||
// Language tag (e.g., en).
|
||||
LanguageTag string `json:"languageTag"`
|
||||
LanguageTag *string `json:"languageTag,omitempty"`
|
||||
// ISO language code.
|
||||
LanguageCode string `json:"languageCode"`
|
||||
LanguageCode *string `json:"languageCode,omitempty"`
|
||||
// Indicates whether header compression is enabled.
|
||||
HeaderCompression *bool `json:"headerCompression,omitempty"`
|
||||
// Dolby Vision BL compatibility ID.
|
||||
@@ -1031,7 +964,8 @@ type GetAllMediaLibraryStream struct {
|
||||
// Coded video height.
|
||||
CodedHeight *int `json:"codedHeight,omitempty"`
|
||||
// Coded video width.
|
||||
CodedWidth *int `json:"codedWidth,omitempty"`
|
||||
CodedWidth *int `json:"codedWidth,omitempty"`
|
||||
ClosedCaptions *bool `json:"closedCaptions,omitempty"`
|
||||
// Color primaries used.
|
||||
ColorPrimaries *string `json:"colorPrimaries,omitempty"`
|
||||
// Color range (e.g., tv).
|
||||
@@ -1050,8 +984,9 @@ type GetAllMediaLibraryStream struct {
|
||||
Original *bool `json:"original,omitempty"`
|
||||
HasScalingMatrix *bool `json:"hasScalingMatrix,omitempty"`
|
||||
// Video profile.
|
||||
Profile *string `json:"profile,omitempty"`
|
||||
ScanType *string `json:"scanType,omitempty"`
|
||||
Profile *string `json:"profile,omitempty"`
|
||||
ScanType *string `json:"scanType,omitempty"`
|
||||
EmbeddedInVideo *string `json:"embeddedInVideo,omitempty"`
|
||||
// Number of reference frames.
|
||||
RefFrames *int `json:"refFrames,omitempty"`
|
||||
// Width of the video stream.
|
||||
@@ -1121,23 +1056,23 @@ func (o *GetAllMediaLibraryStream) GetBitrate() *int {
|
||||
return o.Bitrate
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetLanguage() string {
|
||||
func (o *GetAllMediaLibraryStream) GetLanguage() *string {
|
||||
if o == nil {
|
||||
return ""
|
||||
return nil
|
||||
}
|
||||
return o.Language
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetLanguageTag() string {
|
||||
func (o *GetAllMediaLibraryStream) GetLanguageTag() *string {
|
||||
if o == nil {
|
||||
return ""
|
||||
return nil
|
||||
}
|
||||
return o.LanguageTag
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetLanguageCode() string {
|
||||
func (o *GetAllMediaLibraryStream) GetLanguageCode() *string {
|
||||
if o == nil {
|
||||
return ""
|
||||
return nil
|
||||
}
|
||||
return o.LanguageCode
|
||||
}
|
||||
@@ -1240,6 +1175,13 @@ func (o *GetAllMediaLibraryStream) GetCodedWidth() *int {
|
||||
return o.CodedWidth
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetClosedCaptions() *bool {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.ClosedCaptions
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetColorPrimaries() *string {
|
||||
if o == nil {
|
||||
return nil
|
||||
@@ -1317,6 +1259,13 @@ func (o *GetAllMediaLibraryStream) GetScanType() *string {
|
||||
return o.ScanType
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetEmbeddedInVideo() *string {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.EmbeddedInVideo
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryStream) GetRefFrames() *int {
|
||||
if o == nil {
|
||||
return nil
|
||||
@@ -1592,14 +1541,14 @@ type GetAllMediaLibraryMedia struct {
|
||||
// Video profile (e.g., main 10).
|
||||
VideoProfile *string `json:"videoProfile,omitempty"`
|
||||
// Indicates whether voice activity is detected.
|
||||
HasVoiceActivity bool `json:"hasVoiceActivity"`
|
||||
HasVoiceActivity *bool `json:"hasVoiceActivity,omitempty"`
|
||||
// The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).
|
||||
AudioProfile *string `json:"audioProfile,omitempty"`
|
||||
// Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
OptimizedForStreaming *GetAllMediaLibraryOptimizedForStreaming `json:"optimizedForStreaming,omitempty"`
|
||||
Has64bitOffsets *bool `json:"has64bitOffsets,omitempty"`
|
||||
// An array of parts for this media item.
|
||||
Part []GetAllMediaLibraryPart `json:"Part"`
|
||||
Part []GetAllMediaLibraryPart `json:"Part,omitempty"`
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryMedia) GetID() int64 {
|
||||
@@ -1700,9 +1649,9 @@ func (o *GetAllMediaLibraryMedia) GetVideoProfile() *string {
|
||||
return o.VideoProfile
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryMedia) GetHasVoiceActivity() bool {
|
||||
func (o *GetAllMediaLibraryMedia) GetHasVoiceActivity() *bool {
|
||||
if o == nil {
|
||||
return false
|
||||
return nil
|
||||
}
|
||||
return o.HasVoiceActivity
|
||||
}
|
||||
@@ -1730,13 +1679,14 @@ func (o *GetAllMediaLibraryMedia) GetHas64bitOffsets() *bool {
|
||||
|
||||
func (o *GetAllMediaLibraryMedia) GetPart() []GetAllMediaLibraryPart {
|
||||
if o == nil {
|
||||
return []GetAllMediaLibraryPart{}
|
||||
return nil
|
||||
}
|
||||
return o.Part
|
||||
}
|
||||
|
||||
type GetAllMediaLibraryGenre struct {
|
||||
// The country of origin of this media item
|
||||
// The genre name of this media-item
|
||||
//
|
||||
Tag string `json:"tag"`
|
||||
}
|
||||
|
||||
@@ -1784,7 +1734,7 @@ func (o *GetAllMediaLibraryWriter) GetTag() string {
|
||||
}
|
||||
|
||||
type GetAllMediaLibraryRole struct {
|
||||
// The name of the actor for this role
|
||||
// The display tag for the actor (typically the actor's name).
|
||||
Tag string `json:"tag"`
|
||||
}
|
||||
|
||||
@@ -1795,13 +1745,13 @@ func (o *GetAllMediaLibraryRole) GetTag() string {
|
||||
return o.Tag
|
||||
}
|
||||
|
||||
type Guids struct {
|
||||
type GetAllMediaLibraryGuids struct {
|
||||
// The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
|
||||
//
|
||||
ID *string `json:"id,omitempty"`
|
||||
}
|
||||
|
||||
func (o *Guids) GetID() *string {
|
||||
func (o *GetAllMediaLibraryGuids) GetID() *string {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
@@ -1846,7 +1796,7 @@ type GetAllMediaLibraryMetadata struct {
|
||||
// The audience rating for the media item.
|
||||
AudienceRating float64 `json:"audienceRating"`
|
||||
// The release year of the media item.
|
||||
Year int `json:"year"`
|
||||
Year *int `json:"year,omitempty"`
|
||||
// A brief tagline for the media item.
|
||||
Tagline string `json:"tagline"`
|
||||
// The thumbnail image URL for the media item.
|
||||
@@ -1936,7 +1886,7 @@ type GetAllMediaLibraryMetadata struct {
|
||||
Director []GetAllMediaLibraryDirector `json:"Director,omitempty"`
|
||||
Writer []GetAllMediaLibraryWriter `json:"Writer,omitempty"`
|
||||
Role []GetAllMediaLibraryRole `json:"Role,omitempty"`
|
||||
Guids []Guids `json:"Guid,omitempty"`
|
||||
Guids []GetAllMediaLibraryGuids `json:"Guid,omitempty"`
|
||||
Collection []GetAllMediaLibraryCollection `json:"Collection,omitempty"`
|
||||
}
|
||||
|
||||
@@ -2035,9 +1985,9 @@ func (o *GetAllMediaLibraryMetadata) GetAudienceRating() float64 {
|
||||
return o.AudienceRating
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryMetadata) GetYear() int {
|
||||
func (o *GetAllMediaLibraryMetadata) GetYear() *int {
|
||||
if o == nil {
|
||||
return 0
|
||||
return nil
|
||||
}
|
||||
return o.Year
|
||||
}
|
||||
@@ -2385,7 +2335,7 @@ func (o *GetAllMediaLibraryMetadata) GetRole() []GetAllMediaLibraryRole {
|
||||
return o.Role
|
||||
}
|
||||
|
||||
func (o *GetAllMediaLibraryMetadata) GetGuids() []Guids {
|
||||
func (o *GetAllMediaLibraryMetadata) GetGuids() []GetAllMediaLibraryGuids {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -3,8 +3,6 @@
|
||||
package operations
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
@@ -29,31 +27,6 @@ const (
|
||||
func (e GetCountriesLibraryQueryParamType) ToPointer() *GetCountriesLibraryQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetCountriesLibraryQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v int64
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 1:
|
||||
fallthrough
|
||||
case 2:
|
||||
fallthrough
|
||||
case 3:
|
||||
fallthrough
|
||||
case 4:
|
||||
fallthrough
|
||||
case 8:
|
||||
fallthrough
|
||||
case 9:
|
||||
fallthrough
|
||||
case 10:
|
||||
*e = GetCountriesLibraryQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetCountriesLibraryQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetCountriesLibraryRequest struct {
|
||||
// The unique key of the Plex library.
|
||||
|
||||
@@ -3,8 +3,6 @@
|
||||
package operations
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
@@ -29,31 +27,6 @@ const (
|
||||
func (e GetGenresLibraryQueryParamType) ToPointer() *GetGenresLibraryQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetGenresLibraryQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v int64
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 1:
|
||||
fallthrough
|
||||
case 2:
|
||||
fallthrough
|
||||
case 3:
|
||||
fallthrough
|
||||
case 4:
|
||||
fallthrough
|
||||
case 8:
|
||||
fallthrough
|
||||
case 9:
|
||||
fallthrough
|
||||
case 10:
|
||||
*e = GetGenresLibraryQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetGenresLibraryQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetGenresLibraryRequest struct {
|
||||
// The unique key of the Plex library.
|
||||
|
||||
@@ -35,49 +35,6 @@ const (
|
||||
func (e Tag) ToPointer() *Tag {
|
||||
return &e
|
||||
}
|
||||
func (e *Tag) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "unwatched":
|
||||
fallthrough
|
||||
case "newest":
|
||||
fallthrough
|
||||
case "recentlyAdded":
|
||||
fallthrough
|
||||
case "recentlyViewed":
|
||||
fallthrough
|
||||
case "onDeck":
|
||||
fallthrough
|
||||
case "collection":
|
||||
fallthrough
|
||||
case "edition":
|
||||
fallthrough
|
||||
case "year":
|
||||
fallthrough
|
||||
case "decade":
|
||||
fallthrough
|
||||
case "director":
|
||||
fallthrough
|
||||
case "contentRating":
|
||||
fallthrough
|
||||
case "rating":
|
||||
fallthrough
|
||||
case "resolution":
|
||||
fallthrough
|
||||
case "firstCharacter":
|
||||
fallthrough
|
||||
case "folder":
|
||||
fallthrough
|
||||
case "albums":
|
||||
*e = Tag(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for Tag: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// IncludeGuids - Adds the Guids object to the response
|
||||
type IncludeGuids int
|
||||
@@ -127,31 +84,6 @@ const (
|
||||
func (e GetLibraryItemsQueryParamType) ToPointer() *GetLibraryItemsQueryParamType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsQueryParamType) UnmarshalJSON(data []byte) error {
|
||||
var v int64
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case 1:
|
||||
fallthrough
|
||||
case 2:
|
||||
fallthrough
|
||||
case 3:
|
||||
fallthrough
|
||||
case 4:
|
||||
fallthrough
|
||||
case 8:
|
||||
fallthrough
|
||||
case 9:
|
||||
fallthrough
|
||||
case 10:
|
||||
*e = GetLibraryItemsQueryParamType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsQueryParamType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetLibraryItemsQueryParamIncludeMeta - Adds the Meta object to the response
|
||||
type GetLibraryItemsQueryParamIncludeMeta int
|
||||
@@ -615,157 +547,64 @@ const (
|
||||
func (e GetLibraryItemsLibraryType) ToPointer() *GetLibraryItemsLibraryType {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsLibraryType) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "movie":
|
||||
fallthrough
|
||||
case "show":
|
||||
fallthrough
|
||||
case "season":
|
||||
fallthrough
|
||||
case "episode":
|
||||
fallthrough
|
||||
case "artist":
|
||||
fallthrough
|
||||
case "album":
|
||||
*e = GetLibraryItemsLibraryType(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsLibraryType: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetLibraryItemsFlattenSeasons - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
type GetLibraryItemsFlattenSeasons string
|
||||
// FlattenSeasons - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
type FlattenSeasons string
|
||||
|
||||
const (
|
||||
GetLibraryItemsFlattenSeasonsLibraryDefault GetLibraryItemsFlattenSeasons = "-1"
|
||||
GetLibraryItemsFlattenSeasonsHide GetLibraryItemsFlattenSeasons = "0"
|
||||
GetLibraryItemsFlattenSeasonsShow GetLibraryItemsFlattenSeasons = "1"
|
||||
FlattenSeasonsLibraryDefault FlattenSeasons = "-1"
|
||||
FlattenSeasonsHide FlattenSeasons = "0"
|
||||
FlattenSeasonsShow FlattenSeasons = "1"
|
||||
)
|
||||
|
||||
func (e GetLibraryItemsFlattenSeasons) ToPointer() *GetLibraryItemsFlattenSeasons {
|
||||
func (e FlattenSeasons) ToPointer() *FlattenSeasons {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsFlattenSeasons) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "-1":
|
||||
fallthrough
|
||||
case "0":
|
||||
fallthrough
|
||||
case "1":
|
||||
*e = GetLibraryItemsFlattenSeasons(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsFlattenSeasons: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetLibraryItemsEpisodeSort - Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
type GetLibraryItemsEpisodeSort string
|
||||
// EpisodeSort - Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
type EpisodeSort string
|
||||
|
||||
const (
|
||||
GetLibraryItemsEpisodeSortLibraryDefault GetLibraryItemsEpisodeSort = "-1"
|
||||
GetLibraryItemsEpisodeSortOldestFirst GetLibraryItemsEpisodeSort = "0"
|
||||
GetLibraryItemsEpisodeSortNewestFirst GetLibraryItemsEpisodeSort = "1"
|
||||
EpisodeSortLibraryDefault EpisodeSort = "-1"
|
||||
EpisodeSortOldestFirst EpisodeSort = "0"
|
||||
EpisodeSortNewestFirst EpisodeSort = "1"
|
||||
)
|
||||
|
||||
func (e GetLibraryItemsEpisodeSort) ToPointer() *GetLibraryItemsEpisodeSort {
|
||||
func (e EpisodeSort) ToPointer() *EpisodeSort {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsEpisodeSort) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "-1":
|
||||
fallthrough
|
||||
case "0":
|
||||
fallthrough
|
||||
case "1":
|
||||
*e = GetLibraryItemsEpisodeSort(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsEpisodeSort: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetLibraryItemsEnableCreditsMarkerGeneration - Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
type GetLibraryItemsEnableCreditsMarkerGeneration string
|
||||
// EnableCreditsMarkerGeneration - Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
type EnableCreditsMarkerGeneration string
|
||||
|
||||
const (
|
||||
GetLibraryItemsEnableCreditsMarkerGenerationLibraryDefault GetLibraryItemsEnableCreditsMarkerGeneration = "-1"
|
||||
GetLibraryItemsEnableCreditsMarkerGenerationDisabled GetLibraryItemsEnableCreditsMarkerGeneration = "0"
|
||||
EnableCreditsMarkerGenerationLibraryDefault EnableCreditsMarkerGeneration = "-1"
|
||||
EnableCreditsMarkerGenerationDisabled EnableCreditsMarkerGeneration = "0"
|
||||
)
|
||||
|
||||
func (e GetLibraryItemsEnableCreditsMarkerGeneration) ToPointer() *GetLibraryItemsEnableCreditsMarkerGeneration {
|
||||
func (e EnableCreditsMarkerGeneration) ToPointer() *EnableCreditsMarkerGeneration {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsEnableCreditsMarkerGeneration) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "-1":
|
||||
fallthrough
|
||||
case "0":
|
||||
*e = GetLibraryItemsEnableCreditsMarkerGeneration(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsEnableCreditsMarkerGeneration: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
// GetLibraryItemsShowOrdering - Setting that indicates the episode ordering for the show.
|
||||
// ShowOrdering - Setting that indicates the episode ordering for the show.
|
||||
// None = Library default,
|
||||
// tmdbAiring = The Movie Database (Aired),
|
||||
// aired = TheTVDB (Aired),
|
||||
// dvd = TheTVDB (DVD),
|
||||
// absolute = TheTVDB (Absolute)).
|
||||
type GetLibraryItemsShowOrdering string
|
||||
type ShowOrdering string
|
||||
|
||||
const (
|
||||
GetLibraryItemsShowOrderingNone GetLibraryItemsShowOrdering = "None"
|
||||
GetLibraryItemsShowOrderingTmdbAiring GetLibraryItemsShowOrdering = "tmdbAiring"
|
||||
GetLibraryItemsShowOrderingTvdbAired GetLibraryItemsShowOrdering = "aired"
|
||||
GetLibraryItemsShowOrderingTvdbDvd GetLibraryItemsShowOrdering = "dvd"
|
||||
GetLibraryItemsShowOrderingTvdbAbsolute GetLibraryItemsShowOrdering = "absolute"
|
||||
ShowOrderingNone ShowOrdering = "None"
|
||||
ShowOrderingTmdbAiring ShowOrdering = "tmdbAiring"
|
||||
ShowOrderingTvdbAired ShowOrdering = "aired"
|
||||
ShowOrderingTvdbDvd ShowOrdering = "dvd"
|
||||
ShowOrderingTvdbAbsolute ShowOrdering = "absolute"
|
||||
)
|
||||
|
||||
func (e GetLibraryItemsShowOrdering) ToPointer() *GetLibraryItemsShowOrdering {
|
||||
func (e ShowOrdering) ToPointer() *ShowOrdering {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsShowOrdering) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "None":
|
||||
fallthrough
|
||||
case "tmdbAiring":
|
||||
fallthrough
|
||||
case "aired":
|
||||
fallthrough
|
||||
case "dvd":
|
||||
fallthrough
|
||||
case "absolute":
|
||||
*e = GetLibraryItemsShowOrdering(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsShowOrdering: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetLibraryItemsOptimizedForStreaming int
|
||||
|
||||
@@ -1561,14 +1400,14 @@ func (o *GetLibraryItemsLocation) GetPath() *string {
|
||||
return o.Path
|
||||
}
|
||||
|
||||
type GetLibraryItemsMediaGUID struct {
|
||||
type MediaGUID struct {
|
||||
// Can be one of the following formats:
|
||||
// imdb://tt13015952, tmdb://2434012, tvdb://7945991
|
||||
//
|
||||
ID string `json:"id"`
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMediaGUID) GetID() string {
|
||||
func (o *MediaGUID) GetID() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
@@ -1610,7 +1449,7 @@ func (o *GetLibraryItemsUltraBlurColors) GetBottomLeft() string {
|
||||
return o.BottomLeft
|
||||
}
|
||||
|
||||
type GetLibraryItemsMetaDataRating struct {
|
||||
type MetaDataRating struct {
|
||||
// A URI or path to the rating image.
|
||||
Image string `json:"image"`
|
||||
// The value of the rating.
|
||||
@@ -1619,21 +1458,21 @@ type GetLibraryItemsMetaDataRating struct {
|
||||
Type string `json:"type"`
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetaDataRating) GetImage() string {
|
||||
func (o *MetaDataRating) GetImage() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.Image
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetaDataRating) GetValue() float32 {
|
||||
func (o *MetaDataRating) GetValue() float32 {
|
||||
if o == nil {
|
||||
return 0.0
|
||||
}
|
||||
return o.Value
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetaDataRating) GetType() string {
|
||||
func (o *MetaDataRating) GetType() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
@@ -1652,25 +1491,6 @@ const (
|
||||
func (e GetLibraryItemsLibraryResponse200Type) ToPointer() *GetLibraryItemsLibraryResponse200Type {
|
||||
return &e
|
||||
}
|
||||
func (e *GetLibraryItemsLibraryResponse200Type) UnmarshalJSON(data []byte) error {
|
||||
var v string
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
switch v {
|
||||
case "coverPoster":
|
||||
fallthrough
|
||||
case "background":
|
||||
fallthrough
|
||||
case "snapshot":
|
||||
fallthrough
|
||||
case "clearLogo":
|
||||
*e = GetLibraryItemsLibraryResponse200Type(v)
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("invalid value for GetLibraryItemsLibraryResponse200Type: %v", v)
|
||||
}
|
||||
}
|
||||
|
||||
type GetLibraryItemsImage struct {
|
||||
Alt string `json:"alt"`
|
||||
@@ -1724,11 +1544,11 @@ type GetLibraryItemsMetadata struct {
|
||||
SeasonCount *int `json:"seasonCount,omitempty"`
|
||||
Tagline *string `json:"tagline,omitempty"`
|
||||
// Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
FlattenSeasons *GetLibraryItemsFlattenSeasons `json:"flattenSeasons,omitempty"`
|
||||
FlattenSeasons *FlattenSeasons `json:"flattenSeasons,omitempty"`
|
||||
// Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
EpisodeSort *GetLibraryItemsEpisodeSort `json:"episodeSort,omitempty"`
|
||||
EpisodeSort *EpisodeSort `json:"episodeSort,omitempty"`
|
||||
// Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
EnableCreditsMarkerGeneration *GetLibraryItemsEnableCreditsMarkerGeneration `json:"enableCreditsMarkerGeneration,omitempty"`
|
||||
EnableCreditsMarkerGeneration *EnableCreditsMarkerGeneration `json:"enableCreditsMarkerGeneration,omitempty"`
|
||||
// Setting that indicates the episode ordering for the show.
|
||||
// None = Library default,
|
||||
// tmdbAiring = The Movie Database (Aired),
|
||||
@@ -1736,12 +1556,12 @@ type GetLibraryItemsMetadata struct {
|
||||
// dvd = TheTVDB (DVD),
|
||||
// absolute = TheTVDB (Absolute)).
|
||||
//
|
||||
ShowOrdering *GetLibraryItemsShowOrdering `json:"showOrdering,omitempty"`
|
||||
Thumb *string `json:"thumb,omitempty"`
|
||||
Art *string `json:"art,omitempty"`
|
||||
Banner *string `json:"banner,omitempty"`
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
OriginallyAvailableAt *types.Date `json:"originallyAvailableAt,omitempty"`
|
||||
ShowOrdering *ShowOrdering `json:"showOrdering,omitempty"`
|
||||
Thumb *string `json:"thumb,omitempty"`
|
||||
Art *string `json:"art,omitempty"`
|
||||
Banner *string `json:"banner,omitempty"`
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
OriginallyAvailableAt *types.Date `json:"originallyAvailableAt,omitempty"`
|
||||
// Unix epoch datetime in seconds
|
||||
AddedAt int64 `json:"addedAt"`
|
||||
// Unix epoch datetime in seconds
|
||||
@@ -1771,9 +1591,9 @@ type GetLibraryItemsMetadata struct {
|
||||
Location []GetLibraryItemsLocation `json:"Location,omitempty"`
|
||||
// The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
|
||||
//
|
||||
MediaGUID []GetLibraryItemsMediaGUID `json:"Guid,omitempty"`
|
||||
MediaGUID []MediaGUID `json:"Guid,omitempty"`
|
||||
UltraBlurColors *GetLibraryItemsUltraBlurColors `json:"UltraBlurColors,omitempty"`
|
||||
MetaDataRating []GetLibraryItemsMetaDataRating `json:"Rating,omitempty"`
|
||||
MetaDataRating []MetaDataRating `json:"Rating,omitempty"`
|
||||
Image []GetLibraryItemsImage `json:"Image,omitempty"`
|
||||
TitleSort *string `json:"titleSort,omitempty"`
|
||||
ViewCount *int `json:"viewCount,omitempty"`
|
||||
@@ -1938,28 +1758,28 @@ func (o *GetLibraryItemsMetadata) GetTagline() *string {
|
||||
return o.Tagline
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetFlattenSeasons() *GetLibraryItemsFlattenSeasons {
|
||||
func (o *GetLibraryItemsMetadata) GetFlattenSeasons() *FlattenSeasons {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.FlattenSeasons
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetEpisodeSort() *GetLibraryItemsEpisodeSort {
|
||||
func (o *GetLibraryItemsMetadata) GetEpisodeSort() *EpisodeSort {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.EpisodeSort
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetEnableCreditsMarkerGeneration() *GetLibraryItemsEnableCreditsMarkerGeneration {
|
||||
func (o *GetLibraryItemsMetadata) GetEnableCreditsMarkerGeneration() *EnableCreditsMarkerGeneration {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.EnableCreditsMarkerGeneration
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetShowOrdering() *GetLibraryItemsShowOrdering {
|
||||
func (o *GetLibraryItemsMetadata) GetShowOrdering() *ShowOrdering {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
@@ -2162,7 +1982,7 @@ func (o *GetLibraryItemsMetadata) GetLocation() []GetLibraryItemsLocation {
|
||||
return o.Location
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetMediaGUID() []GetLibraryItemsMediaGUID {
|
||||
func (o *GetLibraryItemsMetadata) GetMediaGUID() []MediaGUID {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
@@ -2176,7 +1996,7 @@ func (o *GetLibraryItemsMetadata) GetUltraBlurColors() *GetLibraryItemsUltraBlur
|
||||
return o.UltraBlurColors
|
||||
}
|
||||
|
||||
func (o *GetLibraryItemsMetadata) GetMetaDataRating() []GetLibraryItemsMetaDataRating {
|
||||
func (o *GetLibraryItemsMetadata) GetMetaDataRating() []MetaDataRating {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
165
models/operations/getmediaarts.go
Normal file
165
models/operations/getmediaarts.go
Normal file
@@ -0,0 +1,165 @@
|
||||
// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
package operations
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
)
|
||||
|
||||
type GetMediaArtsRequest struct {
|
||||
// the id of the library item to return the artwork of.
|
||||
RatingKey int64 `pathParam:"style=simple,explode=false,name=ratingKey"`
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsRequest) GetRatingKey() int64 {
|
||||
if o == nil {
|
||||
return 0
|
||||
}
|
||||
return o.RatingKey
|
||||
}
|
||||
|
||||
type GetMediaArtsMetadata struct {
|
||||
// The URL of the artwork.
|
||||
Key string `json:"key"`
|
||||
// The provider of the artwork.
|
||||
Provider *string `json:"provider,omitempty"`
|
||||
// The URL of the artwork.
|
||||
RatingKey string `json:"ratingKey"`
|
||||
// Whether this is the selected artwork.
|
||||
Selected bool `json:"selected"`
|
||||
// The URL of the artwork thumbnail.
|
||||
Thumb string `json:"thumb"`
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMetadata) GetKey() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.Key
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMetadata) GetProvider() *string {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.Provider
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMetadata) GetRatingKey() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.RatingKey
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMetadata) GetSelected() bool {
|
||||
if o == nil {
|
||||
return false
|
||||
}
|
||||
return o.Selected
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMetadata) GetThumb() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.Thumb
|
||||
}
|
||||
|
||||
type GetMediaArtsMediaContainer struct {
|
||||
// Number of media items returned in this response.
|
||||
Size int `json:"size"`
|
||||
// The version number for media tags.
|
||||
MediaTagVersion int64 `json:"mediaTagVersion"`
|
||||
// The prefix used for media tag resource paths.
|
||||
MediaTagPrefix string `json:"mediaTagPrefix"`
|
||||
// An plugin identifier for the media container.
|
||||
Identifier string `json:"identifier"`
|
||||
Metadata []GetMediaArtsMetadata `json:"Metadata"`
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMediaContainer) GetSize() int {
|
||||
if o == nil {
|
||||
return 0
|
||||
}
|
||||
return o.Size
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMediaContainer) GetMediaTagVersion() int64 {
|
||||
if o == nil {
|
||||
return 0
|
||||
}
|
||||
return o.MediaTagVersion
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMediaContainer) GetMediaTagPrefix() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.MediaTagPrefix
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMediaContainer) GetIdentifier() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.Identifier
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsMediaContainer) GetMetadata() []GetMediaArtsMetadata {
|
||||
if o == nil {
|
||||
return []GetMediaArtsMetadata{}
|
||||
}
|
||||
return o.Metadata
|
||||
}
|
||||
|
||||
// GetMediaArtsResponseBody - The available background artwork for the library item.
|
||||
type GetMediaArtsResponseBody struct {
|
||||
MediaContainer *GetMediaArtsMediaContainer `json:"MediaContainer,omitempty"`
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsResponseBody) GetMediaContainer() *GetMediaArtsMediaContainer {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.MediaContainer
|
||||
}
|
||||
|
||||
type GetMediaArtsResponse struct {
|
||||
// HTTP response content type for this operation
|
||||
ContentType string
|
||||
// HTTP response status code for this operation
|
||||
StatusCode int
|
||||
// Raw HTTP response; suitable for custom response parsing
|
||||
RawResponse *http.Response
|
||||
// The available background artwork for the library item.
|
||||
Object *GetMediaArtsResponseBody
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsResponse) GetContentType() string {
|
||||
if o == nil {
|
||||
return ""
|
||||
}
|
||||
return o.ContentType
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsResponse) GetStatusCode() int {
|
||||
if o == nil {
|
||||
return 0
|
||||
}
|
||||
return o.StatusCode
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsResponse) GetRawResponse() *http.Response {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.RawResponse
|
||||
}
|
||||
|
||||
func (o *GetMediaArtsResponse) GetObject() *GetMediaArtsResponseBody {
|
||||
if o == nil {
|
||||
return nil
|
||||
}
|
||||
return o.Object
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user