mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-07 12:37:45 +00:00
Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
7543285c95 | ||
|
|
fa999ea454 | ||
|
|
b562d2a68e | ||
|
|
09060624f9 | ||
|
|
a6620dfce9 | ||
|
|
100d1e093b | ||
|
|
ff9f3dc489 | ||
|
|
b9629abe33 | ||
|
|
f306faa1ff | ||
|
|
e5abca0f3c | ||
|
|
78acc1880a | ||
|
|
a31aae3cd8 | ||
|
|
bc64130459 | ||
|
|
b553c6204c | ||
|
|
9b02d27d5e | ||
|
|
f200bc563f | ||
|
|
5c4b98300b | ||
|
|
1e46343716 | ||
|
|
c34f35ba3d |
567
.speakeasy/gen.lock
Executable file
567
.speakeasy/gen.lock
Executable file
@@ -0,0 +1,567 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
||||
management:
|
||||
docChecksum: 7aba498c024534142941d65a7c2e649c
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: internal
|
||||
generationVersion: 2.237.3
|
||||
releaseVersion: 0.5.1
|
||||
configChecksum: 168d1f69c7615425697deab74877acce
|
||||
repoURL: https://github.com/LukeHagar/plexjs.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/plexjs
|
||||
published: true
|
||||
features:
|
||||
typescript:
|
||||
constsAndDefaults: 0.1.1
|
||||
core: 3.4.7
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.82.2
|
||||
globalServerURLs: 2.82.1
|
||||
nameOverrides: 2.81.1
|
||||
unions: 2.85.0
|
||||
generatedFiles:
|
||||
- src/sdk/server.ts
|
||||
- src/sdk/media.ts
|
||||
- src/sdk/activities.ts
|
||||
- src/sdk/butler.ts
|
||||
- src/sdk/hubs.ts
|
||||
- src/sdk/search.ts
|
||||
- src/sdk/library.ts
|
||||
- src/sdk/log.ts
|
||||
- src/sdk/playlists.ts
|
||||
- src/sdk/security.ts
|
||||
- src/sdk/sessions.ts
|
||||
- src/sdk/updater.ts
|
||||
- src/sdk/video.ts
|
||||
- src/sdk/sdk.ts
|
||||
- .eslintrc.js
|
||||
- .npmignore
|
||||
- RUNTIMES.md
|
||||
- package-lock.json
|
||||
- package.json
|
||||
- src/index.ts
|
||||
- src/lib/base64.ts
|
||||
- src/lib/config.ts
|
||||
- src/lib/encodings.ts
|
||||
- src/lib/event-streams.ts
|
||||
- src/lib/http.ts
|
||||
- src/lib/retries.ts
|
||||
- src/lib/sdks.ts
|
||||
- src/lib/security.ts
|
||||
- src/lib/url.ts
|
||||
- src/sdk/index.ts
|
||||
- src/models/errors/sdkerror.ts
|
||||
- src/types/blobs.ts
|
||||
- src/types/decimal.ts
|
||||
- src/types/index.ts
|
||||
- src/types/operations.ts
|
||||
- src/types/rfcdate.ts
|
||||
- tsconfig.json
|
||||
- src/models/operations/getservercapabilities.ts
|
||||
- src/models/operations/getserverpreferences.ts
|
||||
- src/models/operations/getavailableclients.ts
|
||||
- src/models/operations/getdevices.ts
|
||||
- src/models/operations/getserveridentity.ts
|
||||
- src/models/operations/getmyplexaccount.ts
|
||||
- src/models/operations/getresizedphoto.ts
|
||||
- src/models/operations/getserverlist.ts
|
||||
- src/models/operations/markplayed.ts
|
||||
- src/models/operations/markunplayed.ts
|
||||
- src/models/operations/updateplayprogress.ts
|
||||
- src/models/operations/getserveractivities.ts
|
||||
- src/models/operations/cancelserveractivities.ts
|
||||
- src/models/operations/getbutlertasks.ts
|
||||
- src/models/operations/startalltasks.ts
|
||||
- src/models/operations/stopalltasks.ts
|
||||
- src/models/operations/starttask.ts
|
||||
- src/models/operations/stoptask.ts
|
||||
- src/models/operations/getglobalhubs.ts
|
||||
- src/models/operations/getlibraryhubs.ts
|
||||
- src/models/operations/performsearch.ts
|
||||
- src/models/operations/performvoicesearch.ts
|
||||
- src/models/operations/getsearchresults.ts
|
||||
- src/models/operations/getfilehash.ts
|
||||
- src/models/operations/getrecentlyadded.ts
|
||||
- src/models/operations/getlibraries.ts
|
||||
- src/models/operations/getlibrary.ts
|
||||
- src/models/operations/deletelibrary.ts
|
||||
- src/models/operations/getlibraryitems.ts
|
||||
- src/models/operations/refreshlibrary.ts
|
||||
- src/models/operations/getmetadata.ts
|
||||
- src/models/operations/getmetadatachildren.ts
|
||||
- src/models/operations/getondeck.ts
|
||||
- src/models/operations/logline.ts
|
||||
- src/models/operations/logmultiline.ts
|
||||
- src/models/operations/enablepapertrail.ts
|
||||
- src/models/operations/createplaylist.ts
|
||||
- src/models/operations/getplaylists.ts
|
||||
- src/models/operations/getplaylist.ts
|
||||
- src/models/operations/deleteplaylist.ts
|
||||
- src/models/operations/updateplaylist.ts
|
||||
- src/models/operations/getplaylistcontents.ts
|
||||
- src/models/operations/clearplaylistcontents.ts
|
||||
- src/models/operations/addplaylistcontents.ts
|
||||
- src/models/operations/uploadplaylist.ts
|
||||
- src/models/operations/gettransienttoken.ts
|
||||
- src/models/operations/getsourceconnectioninformation.ts
|
||||
- src/models/operations/getsessions.ts
|
||||
- src/models/operations/getsessionhistory.ts
|
||||
- src/models/operations/gettranscodesessions.ts
|
||||
- src/models/operations/stoptranscodesession.ts
|
||||
- src/models/operations/getupdatestatus.ts
|
||||
- src/models/operations/checkforupdates.ts
|
||||
- src/models/operations/applyupdates.ts
|
||||
- src/models/operations/startuniversaltranscode.ts
|
||||
- src/models/operations/gettimeline.ts
|
||||
- src/models/errors/getservercapabilities.ts
|
||||
- src/models/errors/getserverpreferences.ts
|
||||
- src/models/errors/getavailableclients.ts
|
||||
- src/models/errors/getdevices.ts
|
||||
- src/models/errors/getserveridentity.ts
|
||||
- src/models/errors/getmyplexaccount.ts
|
||||
- src/models/errors/getresizedphoto.ts
|
||||
- src/models/errors/getserverlist.ts
|
||||
- src/models/errors/markplayed.ts
|
||||
- src/models/errors/markunplayed.ts
|
||||
- src/models/errors/updateplayprogress.ts
|
||||
- src/models/errors/getserveractivities.ts
|
||||
- src/models/errors/cancelserveractivities.ts
|
||||
- src/models/errors/getbutlertasks.ts
|
||||
- src/models/errors/startalltasks.ts
|
||||
- src/models/errors/stopalltasks.ts
|
||||
- src/models/errors/starttask.ts
|
||||
- src/models/errors/stoptask.ts
|
||||
- src/models/errors/getglobalhubs.ts
|
||||
- src/models/errors/getlibraryhubs.ts
|
||||
- src/models/errors/performsearch.ts
|
||||
- src/models/errors/performvoicesearch.ts
|
||||
- src/models/errors/getsearchresults.ts
|
||||
- src/models/errors/getfilehash.ts
|
||||
- src/models/errors/getrecentlyadded.ts
|
||||
- src/models/errors/getlibraries.ts
|
||||
- src/models/errors/getlibrary.ts
|
||||
- src/models/errors/deletelibrary.ts
|
||||
- src/models/errors/refreshlibrary.ts
|
||||
- src/models/errors/getmetadata.ts
|
||||
- src/models/errors/getmetadatachildren.ts
|
||||
- src/models/errors/getondeck.ts
|
||||
- src/models/errors/logline.ts
|
||||
- src/models/errors/logmultiline.ts
|
||||
- src/models/errors/enablepapertrail.ts
|
||||
- src/models/errors/createplaylist.ts
|
||||
- src/models/errors/getplaylists.ts
|
||||
- src/models/errors/getplaylist.ts
|
||||
- src/models/errors/deleteplaylist.ts
|
||||
- src/models/errors/updateplaylist.ts
|
||||
- src/models/errors/getplaylistcontents.ts
|
||||
- src/models/errors/clearplaylistcontents.ts
|
||||
- src/models/errors/addplaylistcontents.ts
|
||||
- src/models/errors/uploadplaylist.ts
|
||||
- src/models/errors/gettransienttoken.ts
|
||||
- src/models/errors/getsourceconnectioninformation.ts
|
||||
- src/models/errors/getsessions.ts
|
||||
- src/models/errors/getsessionhistory.ts
|
||||
- src/models/errors/gettranscodesessions.ts
|
||||
- src/models/errors/stoptranscodesession.ts
|
||||
- src/models/errors/getupdatestatus.ts
|
||||
- src/models/errors/checkforupdates.ts
|
||||
- src/models/errors/applyupdates.ts
|
||||
- src/models/errors/startuniversaltranscode.ts
|
||||
- src/models/errors/gettimeline.ts
|
||||
- src/models/components/security.ts
|
||||
- src/models/errors/index.ts
|
||||
- src/models/operations/index.ts
|
||||
- src/models/components/index.ts
|
||||
- docs/models/operations/directory.md
|
||||
- docs/models/operations/mediacontainer.md
|
||||
- docs/models/operations/getservercapabilitiesresponsebody.md
|
||||
- docs/models/operations/getservercapabilitiesresponse.md
|
||||
- docs/models/operations/two.md
|
||||
- docs/models/operations/one.md
|
||||
- docs/models/operations/setting.md
|
||||
- docs/models/operations/getserverpreferencesmediacontainer.md
|
||||
- docs/models/operations/getserverpreferencesresponsebody.md
|
||||
- docs/models/operations/getserverpreferencesresponse.md
|
||||
- docs/models/operations/server.md
|
||||
- docs/models/operations/getavailableclientsmediacontainer.md
|
||||
- docs/models/operations/getavailableclientsresponsebody.md
|
||||
- docs/models/operations/getavailableclientsresponse.md
|
||||
- docs/models/operations/device.md
|
||||
- docs/models/operations/getdevicesmediacontainer.md
|
||||
- docs/models/operations/getdevicesresponsebody.md
|
||||
- docs/models/operations/getdevicesresponse.md
|
||||
- docs/models/operations/getserveridentitymediacontainer.md
|
||||
- docs/models/operations/getserveridentityresponsebody.md
|
||||
- docs/models/operations/getserveridentityresponse.md
|
||||
- docs/models/operations/myplex.md
|
||||
- docs/models/operations/getmyplexaccountresponsebody.md
|
||||
- docs/models/operations/getmyplexaccountresponse.md
|
||||
- docs/models/operations/minsize.md
|
||||
- docs/models/operations/upscale.md
|
||||
- docs/models/operations/getresizedphotorequest.md
|
||||
- docs/models/operations/getresizedphotoresponse.md
|
||||
- docs/models/operations/getserverlistserver.md
|
||||
- docs/models/operations/getserverlistmediacontainer.md
|
||||
- docs/models/operations/getserverlistresponsebody.md
|
||||
- docs/models/operations/getserverlistresponse.md
|
||||
- docs/models/operations/markplayedrequest.md
|
||||
- docs/models/operations/markplayedresponse.md
|
||||
- docs/models/operations/markunplayedrequest.md
|
||||
- docs/models/operations/markunplayedresponse.md
|
||||
- docs/models/operations/updateplayprogressrequest.md
|
||||
- docs/models/operations/updateplayprogressresponse.md
|
||||
- docs/models/operations/context.md
|
||||
- docs/models/operations/activity.md
|
||||
- docs/models/operations/getserveractivitiesmediacontainer.md
|
||||
- docs/models/operations/getserveractivitiesresponsebody.md
|
||||
- docs/models/operations/getserveractivitiesresponse.md
|
||||
- docs/models/operations/cancelserveractivitiesrequest.md
|
||||
- docs/models/operations/cancelserveractivitiesresponse.md
|
||||
- docs/models/operations/butlertask.md
|
||||
- docs/models/operations/butlertasks.md
|
||||
- docs/models/operations/getbutlertasksresponsebody.md
|
||||
- docs/models/operations/getbutlertasksresponse.md
|
||||
- docs/models/operations/startalltasksresponse.md
|
||||
- docs/models/operations/stopalltasksresponse.md
|
||||
- docs/models/operations/taskname.md
|
||||
- docs/models/operations/starttaskrequest.md
|
||||
- docs/models/operations/starttaskresponse.md
|
||||
- docs/models/operations/pathparamtaskname.md
|
||||
- docs/models/operations/stoptaskrequest.md
|
||||
- docs/models/operations/stoptaskresponse.md
|
||||
- docs/models/operations/onlytransient.md
|
||||
- docs/models/operations/getglobalhubsrequest.md
|
||||
- docs/models/operations/getglobalhubsmetadata.md
|
||||
- docs/models/operations/hub.md
|
||||
- docs/models/operations/getglobalhubsmediacontainer.md
|
||||
- docs/models/operations/getglobalhubsresponsebody.md
|
||||
- docs/models/operations/getglobalhubsresponse.md
|
||||
- docs/models/operations/queryparamonlytransient.md
|
||||
- docs/models/operations/getlibraryhubsrequest.md
|
||||
- docs/models/operations/getlibraryhubspart.md
|
||||
- docs/models/operations/getlibraryhubsmedia.md
|
||||
- docs/models/operations/getlibraryhubsgenre.md
|
||||
- docs/models/operations/getlibraryhubscountry.md
|
||||
- docs/models/operations/getlibraryhubsdirector.md
|
||||
- docs/models/operations/getlibraryhubsrole.md
|
||||
- docs/models/operations/getlibraryhubswriter.md
|
||||
- docs/types/rfcdate.md
|
||||
- docs/models/operations/getlibraryhubsmetadata.md
|
||||
- docs/models/operations/getlibraryhubshub.md
|
||||
- docs/models/operations/getlibraryhubsmediacontainer.md
|
||||
- docs/models/operations/getlibraryhubsresponsebody.md
|
||||
- docs/models/operations/getlibraryhubsresponse.md
|
||||
- docs/models/operations/performsearchrequest.md
|
||||
- docs/models/operations/performsearchresponse.md
|
||||
- docs/models/operations/performvoicesearchrequest.md
|
||||
- docs/models/operations/performvoicesearchresponse.md
|
||||
- docs/models/operations/getsearchresultsrequest.md
|
||||
- docs/models/operations/getsearchresultspart.md
|
||||
- docs/models/operations/getsearchresultsmedia.md
|
||||
- docs/models/operations/getsearchresultsgenre.md
|
||||
- docs/models/operations/getsearchresultsdirector.md
|
||||
- docs/models/operations/getsearchresultswriter.md
|
||||
- docs/models/operations/getsearchresultscountry.md
|
||||
- docs/models/operations/getsearchresultsrole.md
|
||||
- docs/models/operations/getsearchresultsmetadata.md
|
||||
- docs/models/operations/provider.md
|
||||
- docs/models/operations/getsearchresultsmediacontainer.md
|
||||
- docs/models/operations/getsearchresultsresponsebody.md
|
||||
- docs/models/operations/getsearchresultsresponse.md
|
||||
- docs/models/operations/getfilehashrequest.md
|
||||
- docs/models/operations/getfilehashresponse.md
|
||||
- docs/models/operations/part.md
|
||||
- docs/models/operations/media.md
|
||||
- docs/models/operations/genre.md
|
||||
- docs/models/operations/director.md
|
||||
- docs/models/operations/writer.md
|
||||
- docs/models/operations/country.md
|
||||
- docs/models/operations/role.md
|
||||
- docs/models/operations/metadata.md
|
||||
- docs/models/operations/getrecentlyaddedmediacontainer.md
|
||||
- docs/models/operations/getrecentlyaddedresponsebody.md
|
||||
- docs/models/operations/getrecentlyaddedresponse.md
|
||||
- docs/models/operations/location.md
|
||||
- docs/models/operations/getlibrariesdirectory.md
|
||||
- docs/models/operations/getlibrariesmediacontainer.md
|
||||
- docs/models/operations/getlibrariesresponsebody.md
|
||||
- docs/models/operations/getlibrariesresponse.md
|
||||
- docs/models/operations/includedetails.md
|
||||
- docs/models/operations/getlibraryrequest.md
|
||||
- docs/models/operations/getlibrarydirectory.md
|
||||
- docs/models/operations/filter.md
|
||||
- docs/models/operations/sort.md
|
||||
- docs/models/operations/field.md
|
||||
- docs/models/operations/getlibrarytype.md
|
||||
- docs/models/operations/operator.md
|
||||
- docs/models/operations/fieldtype.md
|
||||
- docs/models/operations/getlibrarymediacontainer.md
|
||||
- docs/models/operations/getlibraryresponsebody.md
|
||||
- docs/models/operations/getlibraryresponse.md
|
||||
- docs/models/operations/deletelibraryrequest.md
|
||||
- docs/models/operations/deletelibraryresponse.md
|
||||
- docs/models/operations/tag.md
|
||||
- docs/models/operations/getlibraryitemsrequest.md
|
||||
- docs/models/operations/getlibraryitemspart.md
|
||||
- docs/models/operations/getlibraryitemsmedia.md
|
||||
- docs/models/operations/getlibraryitemsgenre.md
|
||||
- docs/models/operations/getlibraryitemscountry.md
|
||||
- docs/models/operations/getlibraryitemsdirector.md
|
||||
- docs/models/operations/getlibraryitemswriter.md
|
||||
- docs/models/operations/getlibraryitemsrole.md
|
||||
- docs/models/operations/getlibraryitemsmetadata.md
|
||||
- docs/models/operations/getlibraryitemsmediacontainer.md
|
||||
- docs/models/operations/getlibraryitemsresponsebody.md
|
||||
- docs/models/operations/getlibraryitemsresponse.md
|
||||
- docs/models/operations/refreshlibraryrequest.md
|
||||
- docs/models/operations/refreshlibraryresponse.md
|
||||
- docs/models/operations/getmetadatarequest.md
|
||||
- docs/models/operations/stream.md
|
||||
- docs/models/operations/getmetadatapart.md
|
||||
- docs/models/operations/getmetadatamedia.md
|
||||
- docs/models/operations/getmetadatagenre.md
|
||||
- docs/models/operations/getmetadatacountry.md
|
||||
- docs/models/operations/guids.md
|
||||
- docs/models/operations/ratings.md
|
||||
- docs/models/operations/getmetadatadirector.md
|
||||
- docs/models/operations/getmetadatawriter.md
|
||||
- docs/models/operations/getmetadatarole.md
|
||||
- docs/models/operations/producer.md
|
||||
- docs/models/operations/getmetadatametadata.md
|
||||
- docs/models/operations/getmetadatamediacontainer.md
|
||||
- docs/models/operations/getmetadataresponsebody.md
|
||||
- docs/models/operations/getmetadataresponse.md
|
||||
- docs/models/operations/getmetadatachildrenrequest.md
|
||||
- docs/models/operations/getmetadatachildrendirectory.md
|
||||
- docs/models/operations/getmetadatachildrenmetadata.md
|
||||
- docs/models/operations/getmetadatachildrenmediacontainer.md
|
||||
- docs/models/operations/getmetadatachildrenresponsebody.md
|
||||
- docs/models/operations/getmetadatachildrenresponse.md
|
||||
- docs/models/operations/getondeckstream.md
|
||||
- docs/models/operations/getondeckpart.md
|
||||
- docs/models/operations/getondeckmedia.md
|
||||
- docs/models/operations/getondeckguids.md
|
||||
- docs/models/operations/getondeckmetadata.md
|
||||
- docs/models/operations/getondeckmediacontainer.md
|
||||
- docs/models/operations/getondeckresponsebody.md
|
||||
- docs/models/operations/getondeckresponse.md
|
||||
- docs/models/operations/level.md
|
||||
- docs/models/operations/loglinerequest.md
|
||||
- docs/models/operations/loglineresponse.md
|
||||
- docs/models/operations/logmultilineresponse.md
|
||||
- docs/models/operations/enablepapertrailresponse.md
|
||||
- docs/models/operations/typet.md
|
||||
- docs/models/operations/smart.md
|
||||
- docs/models/operations/createplaylistrequest.md
|
||||
- docs/models/operations/createplaylistmetadata.md
|
||||
- docs/models/operations/createplaylistmediacontainer.md
|
||||
- docs/models/operations/createplaylistresponsebody.md
|
||||
- docs/models/operations/createplaylistresponse.md
|
||||
- docs/models/operations/playlisttype.md
|
||||
- docs/models/operations/queryparamsmart.md
|
||||
- docs/models/operations/getplaylistsrequest.md
|
||||
- docs/models/operations/getplaylistsmetadata.md
|
||||
- docs/models/operations/getplaylistsmediacontainer.md
|
||||
- docs/models/operations/getplaylistsresponsebody.md
|
||||
- docs/models/operations/getplaylistsresponse.md
|
||||
- docs/models/operations/getplaylistrequest.md
|
||||
- docs/models/operations/getplaylistmetadata.md
|
||||
- docs/models/operations/getplaylistmediacontainer.md
|
||||
- docs/models/operations/getplaylistresponsebody.md
|
||||
- docs/models/operations/getplaylistresponse.md
|
||||
- docs/models/operations/deleteplaylistrequest.md
|
||||
- docs/models/operations/deleteplaylistresponse.md
|
||||
- docs/models/operations/updateplaylistrequest.md
|
||||
- docs/models/operations/updateplaylistresponse.md
|
||||
- docs/models/operations/getplaylistcontentsrequest.md
|
||||
- docs/models/operations/getplaylistcontentspart.md
|
||||
- docs/models/operations/getplaylistcontentsmedia.md
|
||||
- docs/models/operations/getplaylistcontentsgenre.md
|
||||
- docs/models/operations/getplaylistcontentscountry.md
|
||||
- docs/models/operations/getplaylistcontentsdirector.md
|
||||
- docs/models/operations/getplaylistcontentswriter.md
|
||||
- docs/models/operations/getplaylistcontentsrole.md
|
||||
- docs/models/operations/getplaylistcontentsmetadata.md
|
||||
- docs/models/operations/getplaylistcontentsmediacontainer.md
|
||||
- docs/models/operations/getplaylistcontentsresponsebody.md
|
||||
- docs/models/operations/getplaylistcontentsresponse.md
|
||||
- docs/models/operations/clearplaylistcontentsrequest.md
|
||||
- docs/models/operations/clearplaylistcontentsresponse.md
|
||||
- docs/models/operations/addplaylistcontentsrequest.md
|
||||
- docs/models/operations/addplaylistcontentsmetadata.md
|
||||
- docs/models/operations/addplaylistcontentsmediacontainer.md
|
||||
- docs/models/operations/addplaylistcontentsresponsebody.md
|
||||
- docs/models/operations/addplaylistcontentsresponse.md
|
||||
- docs/models/operations/force.md
|
||||
- docs/models/operations/uploadplaylistrequest.md
|
||||
- docs/models/operations/uploadplaylistresponse.md
|
||||
- docs/models/operations/queryparamtype.md
|
||||
- docs/models/operations/scope.md
|
||||
- docs/models/operations/gettransienttokenrequest.md
|
||||
- docs/models/operations/gettransienttokenresponse.md
|
||||
- docs/models/operations/getsourceconnectioninformationrequest.md
|
||||
- docs/models/operations/getsourceconnectioninformationresponse.md
|
||||
- docs/models/operations/getsessionsstream.md
|
||||
- docs/models/operations/getsessionspart.md
|
||||
- docs/models/operations/getsessionsmedia.md
|
||||
- docs/models/operations/user.md
|
||||
- docs/models/operations/player.md
|
||||
- docs/models/operations/session.md
|
||||
- docs/models/operations/getsessionsmetadata.md
|
||||
- docs/models/operations/getsessionsmediacontainer.md
|
||||
- docs/models/operations/getsessionsresponsebody.md
|
||||
- docs/models/operations/getsessionsresponse.md
|
||||
- docs/models/operations/getsessionhistorymetadata.md
|
||||
- docs/models/operations/getsessionhistorymediacontainer.md
|
||||
- docs/models/operations/getsessionhistoryresponsebody.md
|
||||
- docs/models/operations/getsessionhistoryresponse.md
|
||||
- docs/models/operations/transcodesession.md
|
||||
- docs/models/operations/gettranscodesessionsmediacontainer.md
|
||||
- docs/models/operations/gettranscodesessionsresponsebody.md
|
||||
- docs/models/operations/gettranscodesessionsresponse.md
|
||||
- docs/models/operations/stoptranscodesessionrequest.md
|
||||
- docs/models/operations/stoptranscodesessionresponse.md
|
||||
- docs/models/operations/release.md
|
||||
- docs/models/operations/getupdatestatusmediacontainer.md
|
||||
- docs/models/operations/getupdatestatusresponsebody.md
|
||||
- docs/models/operations/getupdatestatusresponse.md
|
||||
- docs/models/operations/download.md
|
||||
- docs/models/operations/checkforupdatesrequest.md
|
||||
- docs/models/operations/checkforupdatesresponse.md
|
||||
- docs/models/operations/tonight.md
|
||||
- docs/models/operations/skip.md
|
||||
- docs/models/operations/applyupdatesrequest.md
|
||||
- docs/models/operations/applyupdatesresponse.md
|
||||
- docs/models/operations/startuniversaltranscoderequest.md
|
||||
- docs/models/operations/startuniversaltranscoderesponse.md
|
||||
- docs/models/operations/state.md
|
||||
- docs/models/operations/gettimelinerequest.md
|
||||
- docs/models/operations/gettimelineresponse.md
|
||||
- docs/models/errors/errors.md
|
||||
- docs/models/errors/getservercapabilitiesresponsebody.md
|
||||
- docs/models/errors/getserverpreferenceserrors.md
|
||||
- docs/models/errors/getserverpreferencesresponsebody.md
|
||||
- docs/models/errors/getavailableclientserrors.md
|
||||
- docs/models/errors/getavailableclientsresponsebody.md
|
||||
- docs/models/errors/getdeviceserrors.md
|
||||
- docs/models/errors/getdevicesresponsebody.md
|
||||
- docs/models/errors/getserveridentityerrors.md
|
||||
- docs/models/errors/getserveridentityresponsebody.md
|
||||
- docs/models/errors/getmyplexaccounterrors.md
|
||||
- docs/models/errors/getmyplexaccountresponsebody.md
|
||||
- docs/models/errors/getresizedphotoerrors.md
|
||||
- docs/models/errors/getresizedphotoresponsebody.md
|
||||
- docs/models/errors/getserverlisterrors.md
|
||||
- docs/models/errors/getserverlistresponsebody.md
|
||||
- docs/models/errors/markplayederrors.md
|
||||
- docs/models/errors/markplayedresponsebody.md
|
||||
- docs/models/errors/markunplayederrors.md
|
||||
- docs/models/errors/markunplayedresponsebody.md
|
||||
- docs/models/errors/updateplayprogresserrors.md
|
||||
- docs/models/errors/updateplayprogressresponsebody.md
|
||||
- docs/models/errors/getserveractivitieserrors.md
|
||||
- docs/models/errors/getserveractivitiesresponsebody.md
|
||||
- docs/models/errors/cancelserveractivitieserrors.md
|
||||
- docs/models/errors/cancelserveractivitiesresponsebody.md
|
||||
- docs/models/errors/getbutlertaskserrors.md
|
||||
- docs/models/errors/getbutlertasksresponsebody.md
|
||||
- docs/models/errors/startalltaskserrors.md
|
||||
- docs/models/errors/startalltasksresponsebody.md
|
||||
- docs/models/errors/stopalltaskserrors.md
|
||||
- docs/models/errors/stopalltasksresponsebody.md
|
||||
- docs/models/errors/starttaskerrors.md
|
||||
- docs/models/errors/starttaskresponsebody.md
|
||||
- docs/models/errors/stoptaskerrors.md
|
||||
- docs/models/errors/stoptaskresponsebody.md
|
||||
- docs/models/errors/getglobalhubserrors.md
|
||||
- docs/models/errors/getglobalhubsresponsebody.md
|
||||
- docs/models/errors/getlibraryhubserrors.md
|
||||
- docs/models/errors/getlibraryhubsresponsebody.md
|
||||
- docs/models/errors/performsearcherrors.md
|
||||
- docs/models/errors/performsearchresponsebody.md
|
||||
- docs/models/errors/performvoicesearcherrors.md
|
||||
- docs/models/errors/performvoicesearchresponsebody.md
|
||||
- docs/models/errors/getsearchresultserrors.md
|
||||
- docs/models/errors/getsearchresultsresponsebody.md
|
||||
- docs/models/errors/getfilehasherrors.md
|
||||
- docs/models/errors/getfilehashresponsebody.md
|
||||
- docs/models/errors/getrecentlyaddederrors.md
|
||||
- docs/models/errors/getrecentlyaddedresponsebody.md
|
||||
- docs/models/errors/getlibrarieserrors.md
|
||||
- docs/models/errors/getlibrariesresponsebody.md
|
||||
- docs/models/errors/getlibraryerrors.md
|
||||
- docs/models/errors/getlibraryresponsebody.md
|
||||
- docs/models/errors/deletelibraryerrors.md
|
||||
- docs/models/errors/deletelibraryresponsebody.md
|
||||
- docs/models/errors/refreshlibraryerrors.md
|
||||
- docs/models/errors/refreshlibraryresponsebody.md
|
||||
- docs/models/errors/getmetadataerrors.md
|
||||
- docs/models/errors/getmetadataresponsebody.md
|
||||
- docs/models/errors/getmetadatachildrenerrors.md
|
||||
- docs/models/errors/getmetadatachildrenresponsebody.md
|
||||
- docs/models/errors/getondeckerrors.md
|
||||
- docs/models/errors/getondeckresponsebody.md
|
||||
- docs/models/errors/loglineerrors.md
|
||||
- docs/models/errors/loglineresponsebody.md
|
||||
- docs/models/errors/logmultilineerrors.md
|
||||
- docs/models/errors/logmultilineresponsebody.md
|
||||
- docs/models/errors/enablepapertrailerrors.md
|
||||
- docs/models/errors/enablepapertrailresponsebody.md
|
||||
- docs/models/errors/createplaylisterrors.md
|
||||
- docs/models/errors/createplaylistresponsebody.md
|
||||
- docs/models/errors/getplaylistserrors.md
|
||||
- docs/models/errors/getplaylistsresponsebody.md
|
||||
- docs/models/errors/getplaylisterrors.md
|
||||
- docs/models/errors/getplaylistresponsebody.md
|
||||
- docs/models/errors/deleteplaylisterrors.md
|
||||
- docs/models/errors/deleteplaylistresponsebody.md
|
||||
- docs/models/errors/updateplaylisterrors.md
|
||||
- docs/models/errors/updateplaylistresponsebody.md
|
||||
- docs/models/errors/getplaylistcontentserrors.md
|
||||
- docs/models/errors/getplaylistcontentsresponsebody.md
|
||||
- docs/models/errors/clearplaylistcontentserrors.md
|
||||
- docs/models/errors/clearplaylistcontentsresponsebody.md
|
||||
- docs/models/errors/addplaylistcontentserrors.md
|
||||
- docs/models/errors/addplaylistcontentsresponsebody.md
|
||||
- docs/models/errors/uploadplaylisterrors.md
|
||||
- docs/models/errors/uploadplaylistresponsebody.md
|
||||
- docs/models/errors/gettransienttokenerrors.md
|
||||
- docs/models/errors/gettransienttokenresponsebody.md
|
||||
- docs/models/errors/getsourceconnectioninformationerrors.md
|
||||
- docs/models/errors/getsourceconnectioninformationresponsebody.md
|
||||
- docs/models/errors/getsessionserrors.md
|
||||
- docs/models/errors/getsessionsresponsebody.md
|
||||
- docs/models/errors/getsessionhistoryerrors.md
|
||||
- docs/models/errors/getsessionhistoryresponsebody.md
|
||||
- docs/models/errors/gettranscodesessionserrors.md
|
||||
- docs/models/errors/gettranscodesessionsresponsebody.md
|
||||
- docs/models/errors/stoptranscodesessionerrors.md
|
||||
- docs/models/errors/stoptranscodesessionresponsebody.md
|
||||
- docs/models/errors/getupdatestatuserrors.md
|
||||
- docs/models/errors/getupdatestatusresponsebody.md
|
||||
- docs/models/errors/checkforupdateserrors.md
|
||||
- docs/models/errors/checkforupdatesresponsebody.md
|
||||
- docs/models/errors/applyupdateserrors.md
|
||||
- docs/models/errors/applyupdatesresponsebody.md
|
||||
- docs/models/errors/startuniversaltranscodeerrors.md
|
||||
- docs/models/errors/startuniversaltranscoderesponsebody.md
|
||||
- docs/models/errors/gettimelineerrors.md
|
||||
- docs/models/errors/gettimelineresponsebody.md
|
||||
- docs/models/components/security.md
|
||||
- docs/sdks/plexapi/README.md
|
||||
- docs/sdks/server/README.md
|
||||
- docs/sdks/media/README.md
|
||||
- docs/sdks/activities/README.md
|
||||
- docs/sdks/butler/README.md
|
||||
- docs/sdks/hubs/README.md
|
||||
- docs/sdks/search/README.md
|
||||
- docs/sdks/library/README.md
|
||||
- docs/sdks/log/README.md
|
||||
- docs/sdks/playlists/README.md
|
||||
- docs/sdks/security/README.md
|
||||
- docs/sdks/sessions/README.md
|
||||
- docs/sdks/updater/README.md
|
||||
- docs/sdks/video/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
121
README.md
121
README.md
@@ -1,4 +1,4 @@
|
||||
# plexjs
|
||||
# @lukehagar/plexjs
|
||||
|
||||
<div align="left">
|
||||
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
||||
@@ -7,28 +7,19 @@
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
## 🏗 **Welcome to your new SDK!** 🏗
|
||||
|
||||
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
|
||||
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
|
||||
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
|
||||
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
|
||||
- [ ] ✨ When ready to productionize, delete this section from the README
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
npm add plexjs
|
||||
npm add @lukehagar/plexjs
|
||||
```
|
||||
|
||||
### Yarn
|
||||
|
||||
```bash
|
||||
yarn add plexjs
|
||||
yarn add @lukehagar/plexjs
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
@@ -38,20 +29,17 @@ yarn add plexjs
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "plexjs";
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const res = await sdk.server.getServerCapabilities();
|
||||
const result = await sdk.server.getServerCapabilities();
|
||||
|
||||
if (res?.statusCode !== 200) {
|
||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
||||
}
|
||||
|
||||
// handle response
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -112,8 +100,6 @@ run();
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
||||
* [getLatestLibraryItems](docs/sdks/library/README.md#getlatestlibraryitems) - Get Latest Library Items
|
||||
* [getCommonLibraryItems](docs/sdks/library/README.md#getcommonlibraryitems) - Get Common Library Items
|
||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
@@ -173,28 +159,31 @@ All SDK methods return a response object or throw an error. If Error objects are
|
||||
Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "plexjs";
|
||||
import * as errors from "plexjs/models/errors";
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import * as errors from "@lukehagar/plexjs/models/errors";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const res = await sdk.server.getServerCapabilities().catch((err) => {
|
||||
if (err instanceof errors.GetServerCapabilitiesResponseBody) {
|
||||
console.error(err); // handle exception
|
||||
return null;
|
||||
} else {
|
||||
throw err;
|
||||
let result;
|
||||
try {
|
||||
result = await sdk.server.getServerCapabilities();
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case err instanceof errors.GetServerCapabilitiesResponseBody: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if (res?.statusCode !== 200) {
|
||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
||||
}
|
||||
|
||||
// handle response
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -207,14 +196,30 @@ run();
|
||||
|
||||
### Select Server by Index
|
||||
|
||||
You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `http://10.10.10.47:32400` | None |
|
||||
| 1 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const result = await sdk.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
@@ -225,7 +230,26 @@ Some of the server options above contain variables. If you want to set the value
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const result = await sdk.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
@@ -246,8 +270,8 @@ custom header and a timeout to requests and how to use the `"requestError"` hook
|
||||
to log errors:
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "plexjs";
|
||||
import { HTTPClient } from "plexjs/lib/http";
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { HTTPClient } from "@lukehagar/plexjs/lib/http";
|
||||
|
||||
const httpClient = new HTTPClient({
|
||||
// fetcher takes a function that has the same signature as native `fetch`.
|
||||
@@ -290,20 +314,17 @@ This SDK supports the following security scheme globally:
|
||||
|
||||
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { PlexAPI } from "plexjs";
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const res = await sdk.server.getServerCapabilities();
|
||||
const result = await sdk.server.getServerCapabilities();
|
||||
|
||||
if (res?.statusCode !== 200) {
|
||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
||||
}
|
||||
|
||||
// handle response
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -311,6 +332,12 @@ run();
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Start Requirements [requirements] -->
|
||||
## Requirements
|
||||
|
||||
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||
<!-- End Requirements [requirements] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
112
RELEASES.md
112
RELEASES.md
@@ -18,4 +18,114 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.2.0] .
|
||||
### Releases
|
||||
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
|
||||
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
|
||||
|
||||
## 2024-01-01 15:11:44
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.3.0] .
|
||||
### Releases
|
||||
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
|
||||
|
||||
## 2024-01-05 00:27:32
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.130.1 (2.225.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.3.0] .
|
||||
### Releases
|
||||
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
|
||||
|
||||
## 2024-01-05 19:51:02
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.3.1] .
|
||||
### Releases
|
||||
- [NPM v0.3.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.1 - .
|
||||
|
||||
## 2024-01-09 00:28:08
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.134.0 (2.230.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.3.2] .
|
||||
### Releases
|
||||
- [NPM v0.3.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.2 - .
|
||||
|
||||
## 2024-01-10 00:27:58
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.134.1 (2.230.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.3.3] .
|
||||
### Releases
|
||||
- [NPM v0.3.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.3 - .
|
||||
|
||||
## 2024-01-16 00:27:43
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.141.1 (2.233.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.4.0] .
|
||||
### Releases
|
||||
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
|
||||
|
||||
## 2024-01-17 00:27:57
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.142.1 (2.234.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.4.0] .
|
||||
### Releases
|
||||
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
|
||||
|
||||
## 2024-01-18 23:37:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.4.1] .
|
||||
### Releases
|
||||
- [NPM v0.4.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.1 - .
|
||||
|
||||
## 2024-01-19 17:27:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.4.2] .
|
||||
### Releases
|
||||
- [NPM v0.4.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.2 - .
|
||||
|
||||
## 2024-01-20 03:10:24
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.5.0] .
|
||||
### Releases
|
||||
- [NPM v0.5.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.0 - .
|
||||
|
||||
## 2024-01-22 17:16:30
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.5.1] .
|
||||
### Releases
|
||||
- [NPM v0.5.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.1 - .
|
||||
22
RUNTIMES.md
Normal file
22
RUNTIMES.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Supported JavaScript runtimes
|
||||
|
||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
||||
|
||||
* [Web Fetch API][web-fetch]
|
||||
* [Web Streams API](web-streams) and in particular `ReadableStream`
|
||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||
|
||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||
|
||||
Runtime environments that are explicitly supported are:
|
||||
|
||||
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||
- Node.js active and maintenance LTS releases
|
||||
- Currently, this is v18 and v20
|
||||
- Bun v1 and above
|
||||
- Deno v1.39
|
||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||
|
||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||
11
USAGE.md
11
USAGE.md
@@ -1,19 +1,16 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```typescript
|
||||
import { PlexAPI } from "plexjs";
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const res = await sdk.server.getServerCapabilities();
|
||||
const result = await sdk.server.getServerCapabilities();
|
||||
|
||||
if (res?.statusCode !== 200) {
|
||||
throw new Error("Unexpected status code: " + res?.statusCode || "-");
|
||||
}
|
||||
|
||||
// handle response
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetCommonLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLatestLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLatestLibraryItemsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | [errors.GetLatestLibraryItemsErrors](../../models/errors/getlatestlibraryitemserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLibraryItemsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `errors` | [errors.GetLibraryItemsErrors](../../models/errors/getlibraryitemserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AddPlaylistContentsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `metadata` | [operations.AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | [{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}] |
|
||||
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# AddPlaylistContentsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
|
||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 423000 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716458 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705800070 |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | library://.. |
|
||||
| `playQueueID` | *number* | :heavy_check_mark: | the play queue to add to a playlist | 123 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.AddPlaylistContentsResponseBody](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
|
||||
Playlist Updated
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [operations.AddPlaylistContentsMediaContainer](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# CreatePlaylistMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
|
||||
| `metadata` | [operations.CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | [{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}] |
|
||||
23
docs/models/operations/createplaylistmetadata.md
Normal file
23
docs/models/operations/createplaylistmetadata.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CreatePlaylistMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 96 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/96/items |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | A Great Playlist |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | What a great playlist |
|
||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705724593 |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141000 |
|
||||
@@ -8,5 +8,5 @@
|
||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||
| `type` | [operations.TypeT](../../models/operations/typet.md) | :heavy_check_mark: | type of playlist to create |
|
||||
| `smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||
| `uri` | *string* | :heavy_minus_sign: | the content URI for the playlist |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.CreatePlaylistResponseBody](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||
10
docs/models/operations/createplaylistresponsebody.md
Normal file
10
docs/models/operations/createplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistResponseBody
|
||||
|
||||
returns all playlists
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.CreatePlaylistMediaContainer](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/field.md
Normal file
11
docs/models/operations/field.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Field
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | label |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |
|
||||
9
docs/models/operations/fieldtype.md
Normal file
9
docs/models/operations/fieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# FieldType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `operator` | [operations.Operator](../../models/operations/operator.md)[] | :heavy_minus_sign: | N/A | [{"key":"=","title":"is"}] |
|
||||
12
docs/models/operations/filter.md
Normal file
12
docs/models/operations/filter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Filter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | label |
|
||||
| `filterType` | *string* | :heavy_minus_sign: | N/A | string |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/label |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Labels |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | filter |
|
||||
@@ -1,7 +1,9 @@
|
||||
# Force
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `responseBodies` | [operations.ResponseBody](../../models/operations/responsebody.md)[] | :heavy_minus_sign: | Available Clients |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetAvailableClientsResponseBody](../../models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |
|
||||
@@ -1,4 +1,6 @@
|
||||
# ResponseBody
|
||||
# GetAvailableClientsResponseBody
|
||||
|
||||
Available Clients
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetCommonLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *number* | :heavy_check_mark: | item type |
|
||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetCommonLibraryItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetGlobalHubsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 57070 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/items |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | November Movie Day |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Tracks |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
|
||||
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1668787732 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 16873000 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1668779618 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1668787730 |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetGlobalHubsResponseBody](../../models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |
|
||||
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
|
||||
returns global hubs
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [operations.GetGlobalHubsMediaContainer](../../models/operations/getglobalhubsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLatestLibraryItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *number* | :heavy_check_mark: | item type |
|
||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetLatestLibraryItemsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
28
docs/models/operations/getlibrariesdirectory.md
Normal file
28
docs/models/operations/getlibrariesdirectory.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# GetLibrariesDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705615634 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131312 |
|
||||
| `scannedAt` | *number* | :heavy_minus_sign: | N/A | 1705615584 |
|
||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
| `hidden` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `location` | [operations.Location](../../models/operations/location.md)[] | :heavy_minus_sign: | N/A | [{"id":1,"path":"/movies"}] |
|
||||
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibrariesMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Plex Library |
|
||||
| `directory` | [operations.GetLibrariesDirectory](../../models/operations/getlibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | [{"Location":[{"id":1,"path":"/movies"}],"agent":"tv.plex.agents.movie","allowSync":true,"art":"/:/resources/movie-fanart.jpg","composite":"/library/sections/1/composite/1705615584","content":true,"contentChangedAt":3192854,"createdAt":1654131312,"directory":true,"filters":true,"hidden":0,"key":"1","language":"en-US","refreshing":false,"scannedAt":1705615584,"scanner":"Plex Movie","thumb":"/:/resources/movie.png","title":"Movies","type":"movie","updatedAt":1705615634,"uuid":"322a231a-b7f7-49f5-920f-14c61199cd30"}] |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetLibrariesResponseBody](../../models/operations/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetLibrariesMediaContainer](../../models/operations/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/operations/getlibrarydirectory.md
Normal file
12
docs/models/operations/getlibrarydirectory.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetLibraryDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | search?type=1 |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Search... |
|
||||
| `secondary` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `prompt` | *string* | :heavy_minus_sign: | N/A | Search Movies |
|
||||
| `search` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
8
docs/models/operations/getlibraryhubscountry.md
Normal file
8
docs/models/operations/getlibraryhubscountry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Nathan Greno |
|
||||
8
docs/models/operations/getlibraryhubsgenre.md
Normal file
8
docs/models/operations/getlibraryhubsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Animation |
|
||||
19
docs/models/operations/getlibraryhubshub.md
Normal file
19
docs/models/operations/getlibraryhubshub.md
Normal file
File diff suppressed because one or more lines are too long
24
docs/models/operations/getlibraryhubsmedia.md
Normal file
24
docs/models/operations/getlibraryhubsmedia.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetLibraryHubsMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2051 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [operations.GetLibraryHubsPart](../../models/operations/getlibraryhubspart.md)[] | :heavy_minus_sign: | N/A | [{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}] |
|
||||
14
docs/models/operations/getlibraryhubsmediacontainer.md
Normal file
14
docs/models/operations/getlibraryhubsmediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
41
docs/models/operations/getlibraryhubsmetadata.md
Normal file
41
docs/models/operations/getlibraryhubsmetadata.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# GetLibraryHubsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 14944 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Tangled |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.9 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 8.7 |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1704936047 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1589412494 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705739847 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | [operations.GetLibraryHubsMedia](../../models/operations/getlibraryhubsmedia.md)[] | :heavy_minus_sign: | N/A | [{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}] |
|
||||
| `genre` | [operations.GetLibraryHubsGenre](../../models/operations/getlibraryhubsgenre.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Animation"}] |
|
||||
| `country` | [operations.GetLibraryHubsCountry](../../models/operations/getlibraryhubscountry.md)[] | :heavy_minus_sign: | N/A | [{"tag":"United States of America"}] |
|
||||
| `director` | [operations.GetLibraryHubsDirector](../../models/operations/getlibraryhubsdirector.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Nathan Greno"}] |
|
||||
| `role` | [operations.GetLibraryHubsRole](../../models/operations/getlibraryhubsrole.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Donna Murphy"}] |
|
||||
| `writer` | [operations.GetLibraryHubsWriter](../../models/operations/getlibraryhubswriter.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Wilhelm Grimm"}] |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
17
docs/models/operations/getlibraryhubspart.md
Normal file
17
docs/models/operations/getlibraryhubspart.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetLibraryHubsPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 38247 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/38247/1589412494/file.mp4 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4 |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1545647447 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetLibraryHubsResponseBody](../../models/operations/getlibraryhubsresponsebody.md) | :heavy_minus_sign: | The hubs specific to the library |
|
||||
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
10
docs/models/operations/getlibraryhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryHubsResponseBody
|
||||
|
||||
The hubs specific to the library
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetLibraryHubsMediaContainer](../../models/operations/getlibraryhubsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/getlibraryhubsrole.md
Normal file
8
docs/models/operations/getlibraryhubsrole.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Donna Murphy |
|
||||
8
docs/models/operations/getlibraryhubswriter.md
Normal file
8
docs/models/operations/getlibraryhubswriter.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryHubsWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Wilhelm Grimm |
|
||||
8
docs/models/operations/getlibraryitemscountry.md
Normal file
8
docs/models/operations/getlibraryitemscountry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
8
docs/models/operations/getlibraryitemsdirector.md
Normal file
8
docs/models/operations/getlibraryitemsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
8
docs/models/operations/getlibraryitemsgenre.md
Normal file
8
docs/models/operations/getlibraryitemsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
21
docs/models/operations/getlibraryitemsmedia.md
Normal file
21
docs/models/operations/getlibraryitemsmedia.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibraryItemsMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioChannels` | *number* | :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_minus_sign: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `part` | [operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | [{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}] |
|
||||
22
docs/models/operations/getlibraryitemsmediacontainer.md
Normal file
22
docs/models/operations/getlibraryitemsmediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
41
docs/models/operations/getlibraryitemsmetadata.md
Normal file
41
docs/models/operations/getlibraryitemsmetadata.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# GetLibraryItemsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 58683 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `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 |
|
||||
| `media` | [operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | N/A | [{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}] |
|
||||
| `genre` | [operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Adventure"}] |
|
||||
| `country` | [operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | [{"tag":"United States of America"}] |
|
||||
| `director` | [operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | [{"tag":"James Cameron"}] |
|
||||
| `writer` | [operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | [{"tag":"James Cameron"}] |
|
||||
| `role` | [operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Sigourney Weaver"}] |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
14
docs/models/operations/getlibraryitemspart.md
Normal file
14
docs/models/operations/getlibraryitemspart.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
@@ -3,8 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `type` | *number* | :heavy_minus_sign: | item type |
|
||||
| `filter` | *string* | :heavy_minus_sign: | the filter parameter |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query |
|
||||
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetLibraryItemsResponseBody](../../models/operations/getlibraryitemsresponsebody.md) | :heavy_minus_sign: | The contents of the library by section and tag |
|
||||
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
10
docs/models/operations/getlibraryitemsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsResponseBody
|
||||
|
||||
The contents of the library by section and tag
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetLibraryItemsMediaContainer](../../models/operations/getlibraryitemsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/getlibraryitemsrole.md
Normal file
8
docs/models/operations/getlibraryitemsrole.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
||||
8
docs/models/operations/getlibraryitemswriter.md
Normal file
8
docs/models/operations/getlibraryitemswriter.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
22
docs/models/operations/getlibrarymediacontainer.md
Normal file
22
docs/models/operations/getlibrarymediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetLibraryResponseBody](../../models/operations/getlibraryresponsebody.md) | :heavy_minus_sign: | The details of the library |
|
||||
@@ -1,11 +1,10 @@
|
||||
# GetCommonLibraryItemsResponseBody
|
||||
# GetLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
The details of the library
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | [errors.GetCommonLibraryItemsErrors](../../models/errors/getcommonlibraryitemserrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `mediaContainer` | [operations.GetLibraryMediaContainer](../../models/operations/getlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
14
docs/models/operations/getlibrarytype.md
Normal file
14
docs/models/operations/getlibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `filter` | [operations.Filter](../../models/operations/filter.md)[] | :heavy_minus_sign: | N/A | [{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}] |
|
||||
| `sort` | [operations.Sort](../../models/operations/sort.md)[] | :heavy_minus_sign: | N/A | [{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}] |
|
||||
| `field` | [operations.Field](../../models/operations/field.md)[] | :heavy_minus_sign: | N/A | [{"key":"label","subType":"bitrate","title":"Label","type":"tag"}] |
|
||||
12
docs/models/operations/getmetadatachildrendirectory.md
Normal file
12
docs/models/operations/getmetadatachildrendirectory.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMetadataChildrenDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/allLeaves |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | All episodes |
|
||||
30
docs/models/operations/getmetadatachildrenmediacontainer.md
Normal file
30
docs/models/operations/getmetadatachildrenmediacontainer.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GetMetadataChildrenMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | 30072 |
|
||||
| `librarySectionID` | *number* | :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 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `nocache` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia. |
|
||||
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||
| `title2` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | season |
|
||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65593 |
|
||||
| `directory` | [operations.GetMetadataChildrenDirectory](../../models/operations/getmetadatachildrendirectory.md)[] | :heavy_minus_sign: | N/A | [{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}] |
|
||||
| `metadata` | [operations.GetMetadataChildrenMetadata](../../models/operations/getmetadatachildrenmetadata.md)[] | :heavy_minus_sign: | N/A | [{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}] |
|
||||
34
docs/models/operations/getmetadatachildrenmetadata.md
Normal file
34
docs/models/operations/getmetadatachildrenmetadata.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# GetMetadataChildrenMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 66488 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66488/children |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | N/A | 30072 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://season/652aea6549508477c34c6000 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c09190aaccd001f8f42f0 |
|
||||
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | Amazon Studios |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | season |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 11 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705646565 |
|
||||
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66488/thumb/1703065033 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/art/1705739923 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/thumb/1705739923 |
|
||||
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072/theme/1705739923 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1702602021 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1703065033 |
|
||||
| `userRating` | *number* | :heavy_minus_sign: | N/A | 9 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | N/A | 1703881224 |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetMetadataChildrenResponseBody](../../models/operations/getmetadatachildrenresponsebody.md) | :heavy_minus_sign: | The children of the library item. |
|
||||
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
10
docs/models/operations/getmetadatachildrenresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataChildrenResponseBody
|
||||
|
||||
The children of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [operations.GetMetadataChildrenMediaContainer](../../models/operations/getmetadatachildrenmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmetadatacountry.md
Normal file
10
docs/models/operations/getmetadatacountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 116 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | country=116 |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
12
docs/models/operations/getmetadatadirector.md
Normal file
12
docs/models/operations/getmetadatadirector.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMetadataDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 130 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | director=130 |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
10
docs/models/operations/getmetadatagenre.md
Normal file
10
docs/models/operations/getmetadatagenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 184 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | genre=184 |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Thriller |
|
||||
24
docs/models/operations/getmetadatamedia.md
Normal file
24
docs/models/operations/getmetadatamedia.md
Normal file
File diff suppressed because one or more lines are too long
16
docs/models/operations/getmetadatamediacontainer.md
Normal file
16
docs/models/operations/getmetadatamediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
40
docs/models/operations/getmetadatametadata.md
Normal file
40
docs/models/operations/getmetadatametadata.md
Normal file
File diff suppressed because one or more lines are too long
18
docs/models/operations/getmetadatapart.md
Normal file
18
docs/models/operations/getmetadatapart.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMetadataPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `stream` | [operations.Stream](../../models/operations/stream.md)[] | :heavy_minus_sign: | N/A | [{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}] |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetMetadataResponseBody](../../models/operations/getmetadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
10
docs/models/operations/getmetadataresponsebody.md
Normal file
10
docs/models/operations/getmetadataresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMetadataResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetMetadataMediaContainer](../../models/operations/getmetadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmetadatarole.md
Normal file
13
docs/models/operations/getmetadatarole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMetadataRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 220 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | actor=220 |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||
| `role` | *string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||
12
docs/models/operations/getmetadatawriter.md
Normal file
12
docs/models/operations/getmetadatawriter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMetadataWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 132 |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | writer=132 |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
8
docs/models/operations/getondeckguids.md
Normal file
8
docs/models/operations/getondeckguids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetOnDeckGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *string* | :heavy_minus_sign: | N/A | imdb://tt13303712 |
|
||||
@@ -40,4 +40,4 @@
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1654258196 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1654258204 |
|
||||
| `media` | [operations.GetOnDeckMedia](../../models/operations/getondeckmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetOnDeckGuids](../../models/operations/getondeckguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,14 +3,14 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||
| `size` | *number* | :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.Stream](../../models/operations/stream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||
| `size` | *number* | :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 | |
|
||||
30
docs/models/operations/getondeckstream.md
Normal file
30
docs/models/operations/getondeckstream.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GetOnDeckStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 211234 |
|
||||
| `streamType` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `codec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `bitrate` | *number* | :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` | *number* | :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` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | N/A | tv |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | N/A | 25 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `level` | *number* | :heavy_minus_sign: | N/A | 120 |
|
||||
| `profile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `refFrames` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `width` | *number* | :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) |
|
||||
8
docs/models/operations/getplaylistcontentscountry.md
Normal file
8
docs/models/operations/getplaylistcontentscountry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistContentsCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
8
docs/models/operations/getplaylistcontentsdirector.md
Normal file
8
docs/models/operations/getplaylistcontentsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistContentsDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
8
docs/models/operations/getplaylistcontentsgenre.md
Normal file
8
docs/models/operations/getplaylistcontentsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistContentsGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Action |
|
||||
24
docs/models/operations/getplaylistcontentsmedia.md
Normal file
24
docs/models/operations/getplaylistcontentsmedia.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetPlaylistContentsMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2273 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimizedForStreaming` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | [operations.GetPlaylistContentsPart](../../models/operations/getplaylistcontentspart.md)[] | :heavy_minus_sign: | N/A | [{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}] |
|
||||
16
docs/models/operations/getplaylistcontentsmediacontainer.md
Normal file
16
docs/models/operations/getplaylistcontentsmediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
39
docs/models/operations/getplaylistcontentsmetadata.md
Normal file
39
docs/models/operations/getplaylistcontentsmetadata.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# GetPlaylistContentsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Amazing Spider-Man 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | [operations.GetPlaylistContentsMedia](../../models/operations/getplaylistcontentsmedia.md)[] | :heavy_minus_sign: | N/A | [{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}] |
|
||||
| `genre` | [operations.GetPlaylistContentsGenre](../../models/operations/getplaylistcontentsgenre.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Action"}] |
|
||||
| `country` | [operations.GetPlaylistContentsCountry](../../models/operations/getplaylistcontentscountry.md)[] | :heavy_minus_sign: | N/A | [{"tag":"United States of America"}] |
|
||||
| `director` | [operations.GetPlaylistContentsDirector](../../models/operations/getplaylistcontentsdirector.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Joss Whedon"}] |
|
||||
| `writer` | [operations.GetPlaylistContentsWriter](../../models/operations/getplaylistcontentswriter.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Joss Whedon"}] |
|
||||
| `role` | [operations.GetPlaylistContentsRole](../../models/operations/getplaylistcontentsrole.md)[] | :heavy_minus_sign: | N/A | [{"tag":"Gina Torres"}] |
|
||||
17
docs/models/operations/getplaylistcontentspart.md
Normal file
17
docs/models/operations/getplaylistcontentspart.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetPlaylistContentsPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetPlaylistContentsResponseBody](../../models/operations/getplaylistcontentsresponsebody.md) | :heavy_minus_sign: | The playlist contents |
|
||||
10
docs/models/operations/getplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/getplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetPlaylistContentsResponseBody
|
||||
|
||||
The playlist contents
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [operations.GetPlaylistContentsMediaContainer](../../models/operations/getplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/getplaylistcontentsrole.md
Normal file
8
docs/models/operations/getplaylistcontentsrole.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistContentsRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Gina Torres |
|
||||
8
docs/models/operations/getplaylistcontentswriter.md
Normal file
8
docs/models/operations/getplaylistcontentswriter.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetPlaylistContentsWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
9
docs/models/operations/getplaylistmediacontainer.md
Normal file
9
docs/models/operations/getplaylistmediacontainer.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetPlaylistMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `metadata` | [operations.GetPlaylistMetadata](../../models/operations/getplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | [{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}] |
|
||||
22
docs/models/operations/getplaylistmetadata.md
Normal file
22
docs/models/operations/getplaylistmetadata.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetPlaylistMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content` | *string* | :heavy_minus_sign: | N/A | library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1 |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 95 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/95/items |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Smart Movie Playlist |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | |
|
||||
| `smart` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
|
||||
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/95/composite/1705717387 |
|
||||
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 282000 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716493 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705717387 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user