mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.390.7
This commit is contained in:
speakeasybot
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
||||
management:
|
||||
docChecksum: 2ad2b4c59994082e04faa0c3e7675f3e
|
||||
docChecksum: f627107f2ac6c53325be4f291ae2dea7
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: 1.377.1
|
||||
generationVersion: 2.404.1
|
||||
releaseVersion: 0.19.0
|
||||
configChecksum: 685039d8e4f59693f709afebf0849817
|
||||
speakeasyVersion: 1.390.7
|
||||
generationVersion: 2.409.8
|
||||
releaseVersion: 0.20.0
|
||||
configChecksum: 1eb0f35569735ddf4ea84adabb3887ba
|
||||
repoURL: https://github.com/LukeHagar/plexjs.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/plexjs
|
||||
@@ -14,10 +14,11 @@ management:
|
||||
features:
|
||||
typescript:
|
||||
additionalDependencies: 0.1.0
|
||||
constsAndDefaults: 0.1.10
|
||||
core: 3.14.1
|
||||
constsAndDefaults: 0.1.11
|
||||
core: 3.16.1
|
||||
defaultEnabledRetries: 0.1.0
|
||||
deprecations: 2.81.1
|
||||
downloadStreams: 0.1.1
|
||||
envVarSecurityUsage: 0.1.1
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.82.11
|
||||
@@ -31,7 +32,6 @@ features:
|
||||
responseFormat: 0.2.3
|
||||
retries: 2.83.0
|
||||
sdkHooks: 0.1.0
|
||||
typeOverrides: 2.81.1
|
||||
unions: 2.85.7
|
||||
generatedFiles:
|
||||
- src/funcs/serverGetServerCapabilities.ts
|
||||
@@ -41,10 +41,13 @@ generatedFiles:
|
||||
- src/funcs/serverGetServerIdentity.ts
|
||||
- src/funcs/serverGetMyPlexAccount.ts
|
||||
- src/funcs/serverGetResizedPhoto.ts
|
||||
- src/funcs/serverGetMediaProviders.ts
|
||||
- src/funcs/serverGetServerList.ts
|
||||
- src/funcs/mediaMarkPlayed.ts
|
||||
- src/funcs/mediaMarkUnplayed.ts
|
||||
- src/funcs/mediaUpdatePlayProgress.ts
|
||||
- src/funcs/mediaGetBannerImage.ts
|
||||
- src/funcs/mediaGetThumbImage.ts
|
||||
- src/funcs/videoGetTimeline.ts
|
||||
- src/funcs/videoStartUniversalTranscode.ts
|
||||
- src/funcs/activitiesGetServerActivities.ts
|
||||
@@ -58,10 +61,9 @@ generatedFiles:
|
||||
- src/funcs/plexGetUserFriends.ts
|
||||
- src/funcs/plexGetGeoData.ts
|
||||
- src/funcs/plexGetHomeData.ts
|
||||
- src/funcs/plexGetResources.ts
|
||||
- src/funcs/plexGetServerResources.ts
|
||||
- src/funcs/plexGetPin.ts
|
||||
- src/funcs/plexGetTokenByPinId.ts
|
||||
- src/funcs/plexGetUserDetails.ts
|
||||
- src/funcs/hubsGetGlobalHubs.ts
|
||||
- src/funcs/hubsGetLibraryHubs.ts
|
||||
- src/funcs/searchPerformSearch.ts
|
||||
@@ -69,16 +71,17 @@ generatedFiles:
|
||||
- src/funcs/searchGetSearchResults.ts
|
||||
- src/funcs/libraryGetFileHash.ts
|
||||
- src/funcs/libraryGetRecentlyAdded.ts
|
||||
- src/funcs/libraryGetLibraries.ts
|
||||
- src/funcs/libraryGetLibrary.ts
|
||||
- src/funcs/libraryGetAllLibraries.ts
|
||||
- src/funcs/libraryGetLibraryDetails.ts
|
||||
- src/funcs/libraryDeleteLibrary.ts
|
||||
- src/funcs/libraryGetLibraryItems.ts
|
||||
- src/funcs/libraryRefreshLibrary.ts
|
||||
- src/funcs/librarySearchLibrary.ts
|
||||
- src/funcs/libraryGetMetadata.ts
|
||||
- src/funcs/libraryGetRefreshLibraryMetadata.ts
|
||||
- src/funcs/libraryGetSearchLibrary.ts
|
||||
- src/funcs/libraryGetMetaDataByRatingKey.ts
|
||||
- src/funcs/libraryGetMetadataChildren.ts
|
||||
- src/funcs/libraryGetTopWatchedContent.ts
|
||||
- src/funcs/libraryGetOnDeck.ts
|
||||
- src/funcs/watchlistGetWatchList.ts
|
||||
- src/funcs/logLogLine.ts
|
||||
- src/funcs/logLogMultiLine.ts
|
||||
- src/funcs/logEnablePaperTrail.ts
|
||||
@@ -93,6 +96,8 @@ generatedFiles:
|
||||
- src/funcs/playlistsUploadPlaylist.ts
|
||||
- src/funcs/authenticationGetTransientToken.ts
|
||||
- src/funcs/authenticationGetSourceConnectionInformation.ts
|
||||
- src/funcs/authenticationGetUserDetails.ts
|
||||
- src/funcs/authenticationPostUsersSignInData.ts
|
||||
- src/funcs/statisticsGetStatistics.ts
|
||||
- src/funcs/statisticsGetResourcesStatistics.ts
|
||||
- src/funcs/statisticsGetBandwidthStatistics.ts
|
||||
@@ -103,8 +108,6 @@ generatedFiles:
|
||||
- src/funcs/updaterGetUpdateStatus.ts
|
||||
- src/funcs/updaterCheckForUpdates.ts
|
||||
- src/funcs/updaterApplyUpdates.ts
|
||||
- src/funcs/userPostUsersSigninData.ts
|
||||
- src/funcs/watchlistGetWatchlist.ts
|
||||
- src/sdk/server.ts
|
||||
- src/sdk/media.ts
|
||||
- src/sdk/video.ts
|
||||
@@ -114,14 +117,13 @@ generatedFiles:
|
||||
- src/sdk/hubs.ts
|
||||
- src/sdk/search.ts
|
||||
- src/sdk/library.ts
|
||||
- src/sdk/watchlist.ts
|
||||
- src/sdk/log.ts
|
||||
- src/sdk/playlists.ts
|
||||
- src/sdk/authentication.ts
|
||||
- src/sdk/statistics.ts
|
||||
- src/sdk/sessions.ts
|
||||
- src/sdk/updater.ts
|
||||
- src/sdk/user.ts
|
||||
- src/sdk/watchlist.ts
|
||||
- src/sdk/sdk.ts
|
||||
- .eslintrc.cjs
|
||||
- .npmignore
|
||||
@@ -135,6 +137,7 @@ generatedFiles:
|
||||
- src/lib/config.ts
|
||||
- src/lib/dlv.ts
|
||||
- src/lib/encodings.ts
|
||||
- src/lib/files.ts
|
||||
- src/lib/http.ts
|
||||
- src/lib/is-plain-object.ts
|
||||
- src/lib/logger.ts
|
||||
@@ -156,6 +159,7 @@ generatedFiles:
|
||||
- src/types/index.ts
|
||||
- src/types/operations.ts
|
||||
- src/types/rfcdate.ts
|
||||
- src/types/streams.ts
|
||||
- tsconfig.json
|
||||
- src/models/getservercapabilitiesop.ts
|
||||
- src/models/getserverpreferencesop.ts
|
||||
@@ -164,10 +168,13 @@ generatedFiles:
|
||||
- src/models/getserveridentityop.ts
|
||||
- src/models/getmyplexaccountop.ts
|
||||
- src/models/getresizedphotoop.ts
|
||||
- src/models/getmediaprovidersop.ts
|
||||
- src/models/getserverlistop.ts
|
||||
- src/models/markplayedop.ts
|
||||
- src/models/markunplayedop.ts
|
||||
- src/models/updateplayprogressop.ts
|
||||
- src/models/getbannerimageop.ts
|
||||
- src/models/getthumbimageop.ts
|
||||
- src/models/gettimelineop.ts
|
||||
- src/models/startuniversaltranscodeop.ts
|
||||
- src/models/getserveractivitiesop.ts
|
||||
@@ -181,10 +188,9 @@ generatedFiles:
|
||||
- src/models/getuserfriendsop.ts
|
||||
- src/models/getgeodataop.ts
|
||||
- src/models/gethomedataop.ts
|
||||
- src/models/getresourcesop.ts
|
||||
- src/models/getserverresourcesop.ts
|
||||
- src/models/getpinop.ts
|
||||
- src/models/gettokenbypinidop.ts
|
||||
- src/models/getuserdetailsop.ts
|
||||
- src/models/getglobalhubsop.ts
|
||||
- src/models/getlibraryhubsop.ts
|
||||
- src/models/performsearchop.ts
|
||||
@@ -192,16 +198,17 @@ generatedFiles:
|
||||
- src/models/getsearchresultsop.ts
|
||||
- src/models/getfilehashop.ts
|
||||
- src/models/getrecentlyaddedop.ts
|
||||
- src/models/getlibrariesop.ts
|
||||
- src/models/getlibraryop.ts
|
||||
- src/models/getalllibrariesop.ts
|
||||
- src/models/getlibrarydetailsop.ts
|
||||
- src/models/deletelibraryop.ts
|
||||
- src/models/getlibraryitemsop.ts
|
||||
- src/models/refreshlibraryop.ts
|
||||
- src/models/searchlibraryop.ts
|
||||
- src/models/getmetadataop.ts
|
||||
- src/models/getrefreshlibrarymetadataop.ts
|
||||
- src/models/getsearchlibraryop.ts
|
||||
- src/models/getmetadatabyratingkeyop.ts
|
||||
- src/models/getmetadatachildrenop.ts
|
||||
- src/models/gettopwatchedcontentop.ts
|
||||
- src/models/getondeckop.ts
|
||||
- src/models/getwatchlistop.ts
|
||||
- src/models/loglineop.ts
|
||||
- src/models/logmultilineop.ts
|
||||
- src/models/enablepapertrailop.ts
|
||||
@@ -216,6 +223,8 @@ generatedFiles:
|
||||
- src/models/uploadplaylistop.ts
|
||||
- src/models/gettransienttokenop.ts
|
||||
- src/models/getsourceconnectioninformationop.ts
|
||||
- src/models/getuserdetailsop.ts
|
||||
- src/models/postuserssignindataop.ts
|
||||
- src/models/getstatisticsop.ts
|
||||
- src/models/getresourcesstatisticsop.ts
|
||||
- src/models/getbandwidthstatisticsop.ts
|
||||
@@ -226,8 +235,6 @@ generatedFiles:
|
||||
- src/models/getupdatestatusop.ts
|
||||
- src/models/checkforupdatesop.ts
|
||||
- src/models/applyupdatesop.ts
|
||||
- src/models/postuserssignindataop.ts
|
||||
- src/models/getwatchlistop.ts
|
||||
- src/models/security.ts
|
||||
- src/models/index.ts
|
||||
- docs/models/errors.md
|
||||
@@ -254,7 +261,6 @@ generatedFiles:
|
||||
- docs/models/getdevicesmediacontainer.md
|
||||
- docs/models/getdevicesresponsebody.md
|
||||
- docs/models/getdevicesresponse.md
|
||||
- docs/models/getserveridentityerrors.md
|
||||
- docs/models/getserveridentityserverresponsebody.md
|
||||
- docs/models/getserveridentitymediacontainer.md
|
||||
- docs/models/getserveridentityresponsebody.md
|
||||
@@ -270,6 +276,16 @@ generatedFiles:
|
||||
- docs/models/getresizedphotoerrors.md
|
||||
- docs/models/getresizedphotoresponsebody.md
|
||||
- docs/models/getresizedphotoresponse.md
|
||||
- docs/models/getmediaprovidersrequest.md
|
||||
- docs/models/getmediaproviderserrors.md
|
||||
- docs/models/getmediaprovidersserverresponsebody.md
|
||||
- docs/models/pivot.md
|
||||
- docs/models/getmediaprovidersdirectory.md
|
||||
- docs/models/feature.md
|
||||
- docs/models/mediaprovider.md
|
||||
- docs/models/getmediaprovidersmediacontainer.md
|
||||
- docs/models/getmediaprovidersresponsebody.md
|
||||
- docs/models/getmediaprovidersresponse.md
|
||||
- docs/models/getserverlisterrors.md
|
||||
- docs/models/getserverlistserverresponsebody.md
|
||||
- docs/models/getserverlistserver.md
|
||||
@@ -288,6 +304,14 @@ generatedFiles:
|
||||
- docs/models/updateplayprogresserrors.md
|
||||
- docs/models/updateplayprogressresponsebody.md
|
||||
- docs/models/updateplayprogressresponse.md
|
||||
- docs/models/getbannerimagerequest.md
|
||||
- docs/models/getbannerimageerrors.md
|
||||
- docs/models/getbannerimageresponsebody.md
|
||||
- docs/models/getbannerimageresponse.md
|
||||
- docs/models/getthumbimagerequest.md
|
||||
- docs/models/getthumbimageerrors.md
|
||||
- docs/models/getthumbimageresponsebody.md
|
||||
- docs/models/getthumbimageresponse.md
|
||||
- docs/models/state.md
|
||||
- docs/models/gettimelinerequest.md
|
||||
- docs/models/gettimelineerrors.md
|
||||
@@ -349,16 +373,16 @@ generatedFiles:
|
||||
- docs/models/gethomedataplexresponsebody.md
|
||||
- docs/models/gethomedataresponsebody.md
|
||||
- docs/models/gethomedataresponse.md
|
||||
- docs/models/getresourcesglobals.md
|
||||
- docs/models/getserverresourcesglobals.md
|
||||
- docs/models/includehttps.md
|
||||
- docs/models/includerelay.md
|
||||
- docs/models/includeipv6.md
|
||||
- docs/models/getresourcesrequest.md
|
||||
- docs/models/getresourceserrors.md
|
||||
- docs/models/getresourcesresponsebody.md
|
||||
- docs/models/getserverresourcesrequest.md
|
||||
- docs/models/getserverresourceserrors.md
|
||||
- docs/models/getserverresourcesresponsebody.md
|
||||
- docs/models/connections.md
|
||||
- docs/models/plexdevice.md
|
||||
- docs/models/getresourcesresponse.md
|
||||
- docs/models/getserverresourcesresponse.md
|
||||
- docs/models/getpinglobals.md
|
||||
- docs/models/getpinrequest.md
|
||||
- docs/models/getpinerrors.md
|
||||
@@ -368,25 +392,13 @@ generatedFiles:
|
||||
- docs/models/getpinresponse.md
|
||||
- docs/models/gettokenbypinidglobals.md
|
||||
- docs/models/gettokenbypinidrequest.md
|
||||
- docs/models/gettokenbypinidplexerrors.md
|
||||
- docs/models/gettokenbypinidplexresponsebody.md
|
||||
- docs/models/gettokenbypiniderrors.md
|
||||
- docs/models/gettokenbypinidresponsebody.md
|
||||
- docs/models/gettokenbypinidgeodata.md
|
||||
- docs/models/gettokenbypinidauthpincontainer.md
|
||||
- docs/models/gettokenbypinidresponse.md
|
||||
- docs/models/getuserdetailserrors.md
|
||||
- docs/models/getuserdetailsresponsebody.md
|
||||
- docs/models/mailingliststatus.md
|
||||
- docs/models/userprofile.md
|
||||
- docs/models/getuserdetailsstatus.md
|
||||
- docs/models/services.md
|
||||
- docs/models/features.md
|
||||
- docs/models/getuserdetailsplexstatus.md
|
||||
- docs/models/subscription.md
|
||||
- docs/models/getuserdetailsfeatures.md
|
||||
- docs/models/getuserdetailsplexresponsestatus.md
|
||||
- docs/models/getuserdetailssubscription.md
|
||||
- docs/models/getuserdetailsuserplexaccount.md
|
||||
- docs/models/getuserdetailsresponse.md
|
||||
- docs/models/onlytransient.md
|
||||
- docs/models/getglobalhubsrequest.md
|
||||
- docs/models/getglobalhubserrors.md
|
||||
@@ -440,6 +452,7 @@ generatedFiles:
|
||||
- docs/models/getfilehasherrors.md
|
||||
- docs/models/getfilehashresponsebody.md
|
||||
- docs/models/getfilehashresponse.md
|
||||
- docs/models/getrecentlyaddedrequest.md
|
||||
- docs/models/getrecentlyaddederrors.md
|
||||
- docs/models/getrecentlyaddedlibraryresponsebody.md
|
||||
- docs/models/part.md
|
||||
@@ -453,32 +466,35 @@ generatedFiles:
|
||||
- docs/models/getrecentlyaddedmediacontainer.md
|
||||
- docs/models/getrecentlyaddedresponsebody.md
|
||||
- docs/models/getrecentlyaddedresponse.md
|
||||
- docs/models/getlibrarieserrors.md
|
||||
- docs/models/getlibrarieslibraryresponsebody.md
|
||||
- docs/models/getalllibrarieserrors.md
|
||||
- docs/models/getalllibrarieslibraryresponsebody.md
|
||||
- docs/models/location.md
|
||||
- docs/models/getlibrariesdirectory.md
|
||||
- docs/models/getlibrariesmediacontainer.md
|
||||
- docs/models/getlibrariesresponsebody.md
|
||||
- docs/models/getlibrariesresponse.md
|
||||
- docs/models/getalllibrariesdirectory.md
|
||||
- docs/models/getalllibrariesmediacontainer.md
|
||||
- docs/models/getalllibrariesresponsebody.md
|
||||
- docs/models/getalllibrariesresponse.md
|
||||
- docs/models/includedetails.md
|
||||
- docs/models/getlibraryrequest.md
|
||||
- docs/models/getlibraryerrors.md
|
||||
- docs/models/getlibrarylibraryresponsebody.md
|
||||
- docs/models/getlibrarydirectory.md
|
||||
- docs/models/getlibraryfilter.md
|
||||
- docs/models/getlibrarydetailsrequest.md
|
||||
- docs/models/getlibrarydetailserrors.md
|
||||
- docs/models/getlibrarydetailslibraryresponsebody.md
|
||||
- docs/models/getlibrarydetailsdirectory.md
|
||||
- docs/models/getlibrarydetailsfilter.md
|
||||
- docs/models/sort.md
|
||||
- docs/models/field.md
|
||||
- docs/models/getlibrarytype.md
|
||||
- docs/models/getlibrarydetailstype.md
|
||||
- docs/models/operator.md
|
||||
- docs/models/fieldtype.md
|
||||
- docs/models/getlibrarymediacontainer.md
|
||||
- docs/models/getlibraryresponsebody.md
|
||||
- docs/models/getlibraryresponse.md
|
||||
- docs/models/getlibrarydetailsmediacontainer.md
|
||||
- docs/models/getlibrarydetailsresponsebody.md
|
||||
- docs/models/getlibrarydetailsresponse.md
|
||||
- docs/models/deletelibraryrequest.md
|
||||
- docs/models/deletelibraryerrors.md
|
||||
- docs/models/deletelibraryresponsebody.md
|
||||
- docs/models/deletelibraryresponse.md
|
||||
- docs/models/tag.md
|
||||
- docs/models/includeguids.md
|
||||
- docs/models/includemeta.md
|
||||
- docs/models/type.md
|
||||
- docs/models/getlibraryitemsrequest.md
|
||||
- docs/models/getlibraryitemserrors.md
|
||||
- docs/models/getlibraryitemslibraryresponsebody.md
|
||||
@@ -494,36 +510,37 @@ generatedFiles:
|
||||
- docs/models/getlibraryitemsmediacontainer.md
|
||||
- docs/models/getlibraryitemsresponsebody.md
|
||||
- docs/models/getlibraryitemsresponse.md
|
||||
- docs/models/refreshlibraryrequest.md
|
||||
- docs/models/refreshlibraryerrors.md
|
||||
- docs/models/refreshlibraryresponsebody.md
|
||||
- docs/models/refreshlibraryresponse.md
|
||||
- docs/models/type.md
|
||||
- docs/models/searchlibraryrequest.md
|
||||
- docs/models/searchlibraryerrors.md
|
||||
- docs/models/searchlibrarylibraryresponsebody.md
|
||||
- docs/models/searchlibrarymetadata.md
|
||||
- docs/models/searchlibrarymediacontainer.md
|
||||
- docs/models/searchlibraryresponsebody.md
|
||||
- docs/models/searchlibraryresponse.md
|
||||
- docs/models/getmetadatarequest.md
|
||||
- docs/models/getmetadataerrors.md
|
||||
- docs/models/getmetadatalibraryresponsebody.md
|
||||
- docs/models/force.md
|
||||
- docs/models/getrefreshlibrarymetadatarequest.md
|
||||
- docs/models/getrefreshlibrarymetadataerrors.md
|
||||
- docs/models/getrefreshlibrarymetadataresponsebody.md
|
||||
- docs/models/getrefreshlibrarymetadataresponse.md
|
||||
- docs/models/queryparamtype.md
|
||||
- docs/models/getsearchlibraryrequest.md
|
||||
- docs/models/getsearchlibraryerrors.md
|
||||
- docs/models/getsearchlibrarylibraryresponsebody.md
|
||||
- docs/models/getsearchlibrarymetadata.md
|
||||
- docs/models/getsearchlibrarymediacontainer.md
|
||||
- docs/models/getsearchlibraryresponsebody.md
|
||||
- docs/models/getsearchlibraryresponse.md
|
||||
- docs/models/getmetadatabyratingkeyrequest.md
|
||||
- docs/models/getmetadatabyratingkeyerrors.md
|
||||
- docs/models/getmetadatabyratingkeylibraryresponsebody.md
|
||||
- docs/models/stream.md
|
||||
- docs/models/getmetadatapart.md
|
||||
- docs/models/getmetadatamedia.md
|
||||
- docs/models/getmetadatagenre.md
|
||||
- docs/models/getmetadatacountry.md
|
||||
- docs/models/getmetadatabyratingkeypart.md
|
||||
- docs/models/getmetadatabyratingkeymedia.md
|
||||
- docs/models/getmetadatabyratingkeygenre.md
|
||||
- docs/models/getmetadatabyratingkeycountry.md
|
||||
- docs/models/guids.md
|
||||
- docs/models/ratings.md
|
||||
- docs/models/getmetadatadirector.md
|
||||
- docs/models/getmetadatawriter.md
|
||||
- docs/models/getmetadatarole.md
|
||||
- docs/models/getmetadatabyratingkeydirector.md
|
||||
- docs/models/getmetadatabyratingkeywriter.md
|
||||
- docs/models/getmetadatabyratingkeyrole.md
|
||||
- docs/models/producer.md
|
||||
- docs/models/getmetadatametadata.md
|
||||
- docs/models/getmetadatamediacontainer.md
|
||||
- docs/models/getmetadataresponsebody.md
|
||||
- docs/models/getmetadataresponse.md
|
||||
- docs/models/getmetadatabyratingkeymetadata.md
|
||||
- docs/models/getmetadatabyratingkeymediacontainer.md
|
||||
- docs/models/getmetadatabyratingkeyresponsebody.md
|
||||
- docs/models/getmetadatabyratingkeyresponse.md
|
||||
- docs/models/getmetadatachildrenrequest.md
|
||||
- docs/models/getmetadatachildrenerrors.md
|
||||
- docs/models/getmetadatachildrenlibraryresponsebody.md
|
||||
@@ -532,12 +549,15 @@ generatedFiles:
|
||||
- docs/models/getmetadatachildrenmediacontainer.md
|
||||
- docs/models/getmetadatachildrenresponsebody.md
|
||||
- docs/models/getmetadatachildrenresponse.md
|
||||
- docs/models/gettopwatchedcontentqueryparamtype.md
|
||||
- docs/models/gettopwatchedcontentrequest.md
|
||||
- docs/models/gettopwatchedcontenterrors.md
|
||||
- docs/models/gettopwatchedcontentlibraryresponsebody.md
|
||||
- docs/models/gettopwatchedcontentgenre.md
|
||||
- docs/models/gettopwatchedcontentcountry.md
|
||||
- docs/models/gettopwatchedcontentguids.md
|
||||
- docs/models/gettopwatchedcontentrole.md
|
||||
- docs/models/gettopwatchedcontentuser.md
|
||||
- docs/models/user.md
|
||||
- docs/models/gettopwatchedcontentmetadata.md
|
||||
- docs/models/gettopwatchedcontentmediacontainer.md
|
||||
- docs/models/gettopwatchedcontentresponsebody.md
|
||||
@@ -552,6 +572,17 @@ generatedFiles:
|
||||
- docs/models/getondeckmediacontainer.md
|
||||
- docs/models/getondeckresponsebody.md
|
||||
- docs/models/getondeckresponse.md
|
||||
- docs/models/filter.md
|
||||
- docs/models/libtype.md
|
||||
- docs/models/includecollections.md
|
||||
- docs/models/includeexternalmedia.md
|
||||
- docs/models/getwatchlistrequest.md
|
||||
- docs/models/getwatchlisterrors.md
|
||||
- docs/models/getwatchlistwatchlistresponsebody.md
|
||||
- docs/models/image.md
|
||||
- docs/models/metadata.md
|
||||
- docs/models/getwatchlistresponsebody.md
|
||||
- docs/models/getwatchlistresponse.md
|
||||
- docs/models/level.md
|
||||
- docs/models/loglinerequest.md
|
||||
- docs/models/loglineerrors.md
|
||||
@@ -563,7 +594,7 @@ generatedFiles:
|
||||
- docs/models/enablepapertrailerrors.md
|
||||
- docs/models/enablepapertrailresponsebody.md
|
||||
- docs/models/enablepapertrailresponse.md
|
||||
- docs/models/queryparamtype.md
|
||||
- docs/models/createplaylistqueryparamtype.md
|
||||
- docs/models/smart.md
|
||||
- docs/models/createplaylistrequest.md
|
||||
- docs/models/createplaylisterrors.md
|
||||
@@ -596,6 +627,7 @@ generatedFiles:
|
||||
- docs/models/updateplaylisterrors.md
|
||||
- docs/models/updateplaylistresponsebody.md
|
||||
- docs/models/updateplaylistresponse.md
|
||||
- docs/models/getplaylistcontentsqueryparamtype.md
|
||||
- docs/models/getplaylistcontentsrequest.md
|
||||
- docs/models/getplaylistcontentserrors.md
|
||||
- docs/models/getplaylistcontentsplaylistsresponsebody.md
|
||||
@@ -621,7 +653,7 @@ generatedFiles:
|
||||
- docs/models/addplaylistcontentsmediacontainer.md
|
||||
- docs/models/addplaylistcontentsresponsebody.md
|
||||
- docs/models/addplaylistcontentsresponse.md
|
||||
- docs/models/force.md
|
||||
- docs/models/queryparamforce.md
|
||||
- docs/models/uploadplaylistrequest.md
|
||||
- docs/models/uploadplaylisterrors.md
|
||||
- docs/models/uploadplaylistresponsebody.md
|
||||
@@ -636,6 +668,53 @@ generatedFiles:
|
||||
- docs/models/getsourceconnectioninformationerrors.md
|
||||
- docs/models/getsourceconnectioninformationresponsebody.md
|
||||
- docs/models/getsourceconnectioninformationresponse.md
|
||||
- docs/models/getuserdetailsrequest.md
|
||||
- docs/models/getuserdetailserrors.md
|
||||
- docs/models/getuserdetailsresponsebody.md
|
||||
- docs/models/mailingliststatus.md
|
||||
- docs/models/autoselectsubtitle.md
|
||||
- docs/models/defaultsubtitleaccessibility.md
|
||||
- docs/models/defaultsubtitleforced.md
|
||||
- docs/models/watchedindicator.md
|
||||
- docs/models/mediareviewsvisibility.md
|
||||
- docs/models/userprofile.md
|
||||
- docs/models/getuserdetailsstatus.md
|
||||
- docs/models/services.md
|
||||
- docs/models/features.md
|
||||
- docs/models/getuserdetailsauthenticationstatus.md
|
||||
- docs/models/subscription.md
|
||||
- docs/models/getuserdetailsfeatures.md
|
||||
- docs/models/getuserdetailsauthenticationresponsestatus.md
|
||||
- docs/models/getuserdetailssubscription.md
|
||||
- docs/models/getuserdetailsuserplexaccount.md
|
||||
- docs/models/getuserdetailsresponse.md
|
||||
- docs/models/postuserssignindataglobals.md
|
||||
- docs/models/postuserssignindatarequestbody.md
|
||||
- docs/models/postuserssignindatarequest.md
|
||||
- docs/models/postuserssignindataerrors.md
|
||||
- docs/models/postuserssignindataresponsebody.md
|
||||
- docs/models/postuserssignindatamailingliststatus.md
|
||||
- docs/models/postuserssignindataautoselectsubtitle.md
|
||||
- docs/models/postuserssignindatadefaultsubtitleaccessibility.md
|
||||
- docs/models/postuserssignindatadefaultsubtitleforced.md
|
||||
- docs/models/postuserssignindatawatchedindicator.md
|
||||
- docs/models/postuserssignindatamediareviewsvisibility.md
|
||||
- docs/models/postuserssignindatauserprofile.md
|
||||
- docs/models/postuserssignindatastatus.md
|
||||
- docs/models/postuserssignindataservices.md
|
||||
- docs/models/postuserssignindatafeatures.md
|
||||
- docs/models/postuserssignindataauthenticationstatus.md
|
||||
- docs/models/postuserssignindatasubscription.md
|
||||
- docs/models/postuserssignindataauthenticationfeatures.md
|
||||
- docs/models/postuserssignindataauthenticationresponsestatus.md
|
||||
- docs/models/postuserssignindataauthenticationsubscription.md
|
||||
- docs/models/postuserssignindatastate.md
|
||||
- docs/models/internalpaymentmethod.md
|
||||
- docs/models/billing.md
|
||||
- docs/models/pastsubscription.md
|
||||
- docs/models/trials.md
|
||||
- docs/models/postuserssignindatauserplexaccount.md
|
||||
- docs/models/postuserssignindataresponse.md
|
||||
- docs/models/getstatisticsrequest.md
|
||||
- docs/models/getstatisticserrors.md
|
||||
- docs/models/getstatisticsstatisticsresponsebody.md
|
||||
@@ -673,7 +752,7 @@ generatedFiles:
|
||||
- docs/models/getsessionsmediacontainer.md
|
||||
- docs/models/getsessionsresponsebody.md
|
||||
- docs/models/getsessionsresponse.md
|
||||
- docs/models/filter.md
|
||||
- docs/models/queryparamfilter.md
|
||||
- docs/models/getsessionhistoryrequest.md
|
||||
- docs/models/getsessionhistoryerrors.md
|
||||
- docs/models/getsessionhistorysessionsresponsebody.md
|
||||
@@ -708,39 +787,6 @@ generatedFiles:
|
||||
- docs/models/applyupdateserrors.md
|
||||
- docs/models/applyupdatesresponsebody.md
|
||||
- docs/models/applyupdatesresponse.md
|
||||
- docs/models/postuserssignindataglobals.md
|
||||
- docs/models/postuserssignindatarequestbody.md
|
||||
- docs/models/postuserssignindatarequest.md
|
||||
- docs/models/postuserssignindataerrors.md
|
||||
- docs/models/postuserssignindataresponsebody.md
|
||||
- docs/models/postuserssignindatamailingliststatus.md
|
||||
- docs/models/postuserssignindatauserprofile.md
|
||||
- docs/models/postuserssignindatastatus.md
|
||||
- docs/models/postuserssignindataservices.md
|
||||
- docs/models/postuserssignindatafeatures.md
|
||||
- docs/models/postuserssignindatauserstatus.md
|
||||
- docs/models/postuserssignindatasubscription.md
|
||||
- docs/models/postuserssignindatauserfeatures.md
|
||||
- docs/models/postuserssignindatauserresponsestatus.md
|
||||
- docs/models/postuserssignindatausersubscription.md
|
||||
- docs/models/postuserssignindatastate.md
|
||||
- docs/models/internalpaymentmethod.md
|
||||
- docs/models/billing.md
|
||||
- docs/models/pastsubscription.md
|
||||
- docs/models/trials.md
|
||||
- docs/models/postuserssignindatauserplexaccount.md
|
||||
- docs/models/postuserssignindataresponse.md
|
||||
- docs/models/pathparamfilter.md
|
||||
- docs/models/libtype.md
|
||||
- docs/models/includecollections.md
|
||||
- docs/models/includeexternalmedia.md
|
||||
- docs/models/getwatchlistrequest.md
|
||||
- docs/models/getwatchlisterrors.md
|
||||
- docs/models/getwatchlistwatchlistresponsebody.md
|
||||
- docs/models/image.md
|
||||
- docs/models/metadata.md
|
||||
- docs/models/getwatchlistresponsebody.md
|
||||
- docs/models/getwatchlistresponse.md
|
||||
- docs/models/security.md
|
||||
- docs/sdks/plexapi/README.md
|
||||
- docs/lib/utils/retryconfig.md
|
||||
@@ -753,14 +799,13 @@ generatedFiles:
|
||||
- docs/sdks/hubs/README.md
|
||||
- docs/sdks/search/README.md
|
||||
- docs/sdks/library/README.md
|
||||
- docs/sdks/watchlist/README.md
|
||||
- docs/sdks/log/README.md
|
||||
- docs/sdks/playlists/README.md
|
||||
- docs/sdks/authentication/README.md
|
||||
- docs/sdks/statistics/README.md
|
||||
- docs/sdks/sessions/README.md
|
||||
- docs/sdks/updater/README.md
|
||||
- docs/sdks/user/README.md
|
||||
- docs/sdks/watchlist/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
- src/hooks/hooks.ts
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
typescript:
|
||||
version: 0.19.0
|
||||
version: 0.20.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
speakeasyVersion: 1.377.1
|
||||
speakeasyVersion: 1.390.7
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||
sourceRevisionDigest: sha256:fff67c8d70fdb1711caf3e9c61cdc91a4c88ac98b3419c1d287db6ca95c7278b
|
||||
sourceBlobDigest: sha256:235067aeeeba40f6a4b062d9b9e6816a6e1282023f9664b46cbc1af6495b4c53
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -11,10 +11,10 @@ targets:
|
||||
plexjs:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:4e103669d4bcf7c698608fa37524f3d644510de45959c5437c21b60b2fb2dd9f
|
||||
sourceBlobDigest: sha256:3cb937b6d66508640fa6080fa4c16ebef73a438fbb21a1f8833d6dd2e8fcd5ee
|
||||
sourceRevisionDigest: sha256:fff67c8d70fdb1711caf3e9c61cdc91a4c88ac98b3419c1d287db6ca95c7278b
|
||||
sourceBlobDigest: sha256:235067aeeeba40f6a4b062d9b9e6816a6e1282023f9664b46cbc1af6495b4c53
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:439dcb28ca6dc855201641d70fc56ac3a6685187d824eb3077145b6a5be15b8b
|
||||
codeSamplesRevisionDigest: sha256:18919b4d52e4482e8771f2e3657d74cae7f332e481471d177e5b248a9ffc99bd
|
||||
outLocation: /github/workspace/repo
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
|
||||
@@ -27,7 +27,7 @@ import { SDKValidationError } from "@lukehagar/plexjs/models/sdkvalidationerror.
|
||||
// You can create one instance of it to use across an application.
|
||||
const plexAPI = new PlexAPICore({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
154
README.md
154
README.md
@@ -7,9 +7,34 @@
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<!-- Start Summary [summary] -->
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
## Table of Contents
|
||||
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [Requirements](#requirements)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
* [Custom HTTP Client](#custom-http-client)
|
||||
* [Authentication](#authentication)
|
||||
* [Debugging](#debugging)
|
||||
<!-- End Table of Contents [toc] -->
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
@@ -48,7 +73,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -75,6 +100,7 @@ run();
|
||||
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||
* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||
|
||||
### [media](docs/sdks/media/README.md)
|
||||
@@ -82,6 +108,8 @@ run();
|
||||
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
|
||||
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
|
||||
|
||||
### [video](docs/sdks/video/README.md)
|
||||
|
||||
@@ -107,10 +135,9 @@ run();
|
||||
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
|
||||
* [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
|
||||
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
||||
* [getResources](docs/sdks/plex/README.md#getresources) - Get Resources
|
||||
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
|
||||
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
||||
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||
* [getUserDetails](docs/sdks/plex/README.md#getuserdetails) - Get UserData By Token
|
||||
|
||||
### [hubs](docs/sdks/hubs/README.md)
|
||||
|
||||
@@ -127,17 +154,21 @@ run();
|
||||
|
||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
||||
* [getLibraries](docs/sdks/library/README.md#getlibraries) - Get All Libraries
|
||||
* [getLibrary](docs/sdks/library/README.md#getlibrary) - Get Library Details
|
||||
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [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
|
||||
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
@@ -160,6 +191,8 @@ run();
|
||||
|
||||
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token.
|
||||
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||
* [getUserDetails](docs/sdks/authentication/README.md#getuserdetails) - Get User Data By Token
|
||||
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User SignIn Data
|
||||
|
||||
### [statistics](docs/sdks/statistics/README.md)
|
||||
|
||||
@@ -179,14 +212,6 @@ run();
|
||||
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||
|
||||
### [user](docs/sdks/user/README.md)
|
||||
|
||||
* [postUsersSigninData](docs/sdks/user/README.md#postuserssignindata) - Get User SignIn Data
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [getWatchlist](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
@@ -203,18 +228,21 @@ Validation errors can also occur when either method arguments or data returned f
|
||||
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetServerCapabilitiesServerResponseBody, PlexAPI } from "@lukehagar/plexjs";
|
||||
import { SDKValidationError } from "@lukehagar/plexjs/models";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
let result;
|
||||
try {
|
||||
result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case err instanceof SDKValidationError: {
|
||||
@@ -224,8 +252,9 @@ async function run() {
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case err instanceof models.GetServerCapabilitiesServerResponseBody: {
|
||||
console.error(err); // handle exception
|
||||
case err instanceof GetServerCapabilitiesServerResponseBody: {
|
||||
// Handle err.data$: GetServerCapabilitiesServerResponseBodyData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
@@ -233,9 +262,6 @@ async function run() {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -252,7 +278,7 @@ You can override the default server globally by passing a server index to the `s
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `{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 `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -260,7 +286,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -291,7 +317,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -313,7 +339,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -396,7 +422,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -436,6 +462,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities)
|
||||
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation)
|
||||
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken)
|
||||
- [authenticationGetUserDetails](docs/sdks/authentication/README.md#getuserdetails)
|
||||
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata)
|
||||
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks)
|
||||
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks)
|
||||
- [butlerStartTask](docs/sdks/butler/README.md#starttask)
|
||||
@@ -444,20 +472,22 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs)
|
||||
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs)
|
||||
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary)
|
||||
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries)
|
||||
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash)
|
||||
- [libraryGetLibraries](docs/sdks/library/README.md#getlibraries)
|
||||
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails)
|
||||
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems)
|
||||
- [libraryGetLibrary](docs/sdks/library/README.md#getlibrary)
|
||||
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey)
|
||||
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren)
|
||||
- [libraryGetMetadata](docs/sdks/library/README.md#getmetadata)
|
||||
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck)
|
||||
- [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded)
|
||||
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata)
|
||||
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary)
|
||||
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent)
|
||||
- [libraryRefreshLibrary](docs/sdks/library/README.md#refreshlibrary)
|
||||
- [librarySearchLibrary](docs/sdks/library/README.md#searchlibrary)
|
||||
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail)
|
||||
- [logLogLine](docs/sdks/log/README.md#logline)
|
||||
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline)
|
||||
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage)
|
||||
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage)
|
||||
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed)
|
||||
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed)
|
||||
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress)
|
||||
@@ -474,15 +504,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata)
|
||||
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata)
|
||||
- [plexGetPin](docs/sdks/plex/README.md#getpin)
|
||||
- [plexGetResources](docs/sdks/plex/README.md#getresources)
|
||||
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources)
|
||||
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid)
|
||||
- [plexGetUserDetails](docs/sdks/plex/README.md#getuserdetails)
|
||||
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends)
|
||||
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults)
|
||||
- [searchPerformSearch](docs/sdks/search/README.md#performsearch)
|
||||
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch)
|
||||
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients)
|
||||
- [serverGetDevices](docs/sdks/server/README.md#getdevices)
|
||||
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders)
|
||||
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount)
|
||||
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto)
|
||||
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities)
|
||||
@@ -499,15 +529,61 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates)
|
||||
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates)
|
||||
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus)
|
||||
- [userPostUsersSigninData](docs/sdks/user/README.md#postuserssignindata)
|
||||
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline)
|
||||
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode)
|
||||
- [watchlistGetWatchlist](docs/sdks/watchlist/README.md#getwatchlist)
|
||||
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
|
||||
|
||||
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameter is available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { IncludeHttps, IncludeIPv6, IncludeRelay, PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.plex.getServerResources({
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
includeHttps: IncludeHttps.One,
|
||||
includeRelay: IncludeRelay.One,
|
||||
includeIPv6: IncludeIPv6.One,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
@@ -519,7 +595,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -560,7 +636,7 @@ const plexAPI = new PlexAPI({
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
10
RELEASES.md
10
RELEASES.md
@@ -939,3 +939,13 @@ Based on:
|
||||
- [typescript v0.19.0] .
|
||||
### Releases
|
||||
- [NPM v0.19.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.19.0 - .
|
||||
|
||||
## 2024-09-06 00:01:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.390.7 (2.409.8) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.0] .
|
||||
### Releases
|
||||
- [NPM v0.20.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.20.0 - .
|
||||
2
USAGE.md
2
USAGE.md
@@ -4,7 +4,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
1899
codeSamples.yaml
1899
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 6350.59,
|
||||
playlistID: 6625.27,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 161309,
|
||||
statusCode: 820994,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -16,4 +16,4 @@ let value: ApplyUpdatesRequest = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tonight` | [models.Tonight](../models/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
||||
| `skip` | [models.Skip](../models/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
||||
| `skip` | [models.Skip](../models/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 138183,
|
||||
statusCode: 318569,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
18
docs/models/autoselectsubtitle.md
Normal file
18
docs/models/autoselectsubtitle.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# AutoSelectSubtitle
|
||||
|
||||
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { AutoSelectSubtitle } from "@lukehagar/plexjs";
|
||||
|
||||
let value: AutoSelectSubtitle = AutoSelectSubtitle.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 368725,
|
||||
paymentMethodId: 317983,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CancelServerActivitiesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 477665,
|
||||
statusCode: 791725,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 317202,
|
||||
statusCode: 277718,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 6527.9,
|
||||
playlistID: 9495.72,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 208876,
|
||||
statusCode: 368725,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -5,17 +5,25 @@
|
||||
```typescript
|
||||
import { Connections } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Connections = {};
|
||||
let value: Connections = {
|
||||
protocol: "<value>",
|
||||
address: "971 Strosin Wall",
|
||||
port: 4736.08,
|
||||
uri: "https://starry-initialise.name",
|
||||
local: false,
|
||||
relay: false,
|
||||
iPv6: false,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `protocol` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `address` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `port` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `uri` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `local` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `relay` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `iPv6` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `protocol` | *string* | :heavy_check_mark: | N/A |
|
||||
| `address` | *string* | :heavy_check_mark: | N/A |
|
||||
| `port` | *number* | :heavy_check_mark: | N/A |
|
||||
| `uri` | *string* | :heavy_check_mark: | N/A |
|
||||
| `local` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | N/A |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |
|
||||
19
docs/models/createplaylistqueryparamtype.md
Normal file
19
docs/models/createplaylistqueryparamtype.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreatePlaylistQueryParamType
|
||||
|
||||
type of playlist to create
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
@@ -3,22 +3,22 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePlaylistRequest, QueryParamType, Smart } from "@lukehagar/plexjs";
|
||||
import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: QueryParamType.Photo,
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://deadly-corsage.info",
|
||||
uri: "https://exotic-harm.info",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||
| `type` | [models.QueryParamType](../models/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
||||
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||
| `type` | [models.CreatePlaylistQueryParamType](../models/createplaylistqueryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
||||
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
|
||||
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 128926,
|
||||
statusCode: 474697,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
18
docs/models/defaultsubtitleaccessibility.md
Normal file
18
docs/models/defaultsubtitleaccessibility.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# DefaultSubtitleAccessibility
|
||||
|
||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DefaultSubtitleAccessibility } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DefaultSubtitleAccessibility = DefaultSubtitleAccessibility.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
18
docs/models/defaultsubtitleforced.md
Normal file
18
docs/models/defaultsubtitleforced.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# DefaultSubtitleForced
|
||||
|
||||
The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DefaultSubtitleForced } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DefaultSubtitleForced = DefaultSubtitleForced.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -6,12 +6,12 @@
|
||||
import { DeleteLibraryRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DeleteLibraryRequest = {
|
||||
sectionId: 1000,
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DeleteLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 736918,
|
||||
statusCode: 697631,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 5701.97,
|
||||
playlistID: 6747.52,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 38425,
|
||||
statusCode: 656330,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 99280,
|
||||
statusCode: 208876,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
17
docs/models/feature.md
Normal file
17
docs/models/feature.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Feature
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Feature } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Feature = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `directory` | [models.GetMediaProvidersDirectory](../models/getmediaprovidersdirectory.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -5,7 +5,7 @@
|
||||
```typescript
|
||||
import { Features } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Features = Features.SharedServerNotification;
|
||||
let value: Features = Features.WatchTogetherInvite;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
# Filter
|
||||
|
||||
Filters content by field and direction/equality
|
||||
(Unknown if viewedAt is the only supported column)
|
||||
|
||||
Filter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs";
|
||||
|
||||
let value: Filter = {};
|
||||
let value: Filter = Filter.Available;
|
||||
```
|
||||
|
||||
## Fields
|
||||
## Values
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
@@ -1,10 +1,6 @@
|
||||
# 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 the refresh even if the library is already being refreshed.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibrariesDirectory
|
||||
# GetAllLibrariesDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesDirectory } from "@lukehagar/plexjs";
|
||||
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesDirectory = {
|
||||
let value: GetAllLibrariesDirectory = {
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
@@ -19,9 +19,9 @@ let value: GetLibrariesDirectory = {
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
@@ -52,9 +52,9 @@ let value: GetLibrariesDirectory = {
|
||||
| `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 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetResourcesErrors
|
||||
# GetAllLibrariesErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesErrors } from "@lukehagar/plexjs";
|
||||
import { GetAllLibrariesErrors } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetResourcesErrors = {
|
||||
let value: GetAllLibrariesErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataLibraryResponseBody
|
||||
# GetAllLibrariesLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
import { GetAllLibrariesLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetMetadataLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetMetadataErrors](../models/getmetadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `errors` | [models.GetAllLibrariesErrors](../models/getalllibrarieserrors.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 |
|
||||
52
docs/models/getalllibrariesmediacontainer.md
Normal file
52
docs/models/getalllibrariesmediacontainer.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# GetAllLibrariesMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetAllLibrariesMediaContainer = {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||
| `directory` | [models.GetAllLibrariesDirectory](../models/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
61
docs/models/getalllibrariesresponse.md
Normal file
61
docs/models/getalllibrariesresponse.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# GetAllLibrariesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 613064,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| `object` | [models.GetAllLibrariesResponseBody](../models/getalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
@@ -1,13 +1,13 @@
|
||||
# GetLibrariesResponseBody
|
||||
# GetAllLibrariesResponseBody
|
||||
|
||||
The libraries available on the Server
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesResponseBody } from "@lukehagar/plexjs";
|
||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesResponseBody = {
|
||||
let value: GetAllLibrariesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
@@ -27,9 +27,9 @@ let value: GetLibrariesResponseBody = {
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
@@ -48,6 +48,6 @@ let value: GetLibrariesResponseBody = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetLibrariesMediaContainer](../models/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetAllLibrariesMediaContainer](../models/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -31,6 +31,7 @@ let value: GetBandwidthStatisticsMediaContainer = {
|
||||
statisticsBandwidth: [
|
||||
{
|
||||
accountID: 238960586,
|
||||
deviceID: 208,
|
||||
timespan: 6,
|
||||
at: 1718387650,
|
||||
lan: true,
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 623510,
|
||||
statusCode: 916723,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -38,6 +38,7 @@ let value: GetBandwidthStatisticsResponse = {
|
||||
statisticsBandwidth: [
|
||||
{
|
||||
accountID: 238960586,
|
||||
deviceID: 208,
|
||||
timespan: 6,
|
||||
at: 1718387650,
|
||||
lan: true,
|
||||
|
||||
@@ -34,6 +34,7 @@ let value: GetBandwidthStatisticsResponseBody = {
|
||||
statisticsBandwidth: [
|
||||
{
|
||||
accountID: 238960586,
|
||||
deviceID: 208,
|
||||
timespan: 6,
|
||||
at: 1718387650,
|
||||
lan: true,
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibrariesErrors
|
||||
# GetBannerImageErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesErrors } from "@lukehagar/plexjs";
|
||||
import { GetBannerImageErrors } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesErrors = {
|
||||
let value: GetBannerImageErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
27
docs/models/getbannerimagerequest.md
Normal file
27
docs/models/getbannerimagerequest.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# GetBannerImageRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetBannerImageRequest = {
|
||||
ratingKey: 9518,
|
||||
width: 396,
|
||||
height: 396,
|
||||
minSize: 1,
|
||||
upscale: 1,
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| `width` | *number* | :heavy_check_mark: | N/A | 396 |
|
||||
| `height` | *number* | :heavy_check_mark: | N/A | 396 |
|
||||
| `minSize` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `upscale` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
19
docs/models/getbannerimageresponse.md
Normal file
19
docs/models/getbannerimageresponse.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetBannerImageResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetBannerImageResponse } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| `responseStream` | *ReadableStream<Uint8Array>* | :heavy_minus_sign: | Successful response returning an image |
|
||||
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
|
||||
@@ -1,11 +1,11 @@
|
||||
# RefreshLibraryResponseBody
|
||||
# GetBannerImageResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { RefreshLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
import { GetBannerImageResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { RefreshLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.RefreshLibraryErrors](../models/refreshlibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `errors` | [models.GetBannerImageErrors](../models/getbannerimageerrors.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 |
|
||||
@@ -7,7 +7,7 @@ import { GetButlerTasksResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetButlerTasksResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 791725,
|
||||
statusCode: 812169,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetCompanionsDataResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetCompanionsDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 337396,
|
||||
statusCode: 87129,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetFileHashResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 414662,
|
||||
statusCode: 449950,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetGeoDataResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetGeoDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 648172,
|
||||
statusCode: 20218,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetGlobalHubsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetGlobalHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 639921,
|
||||
statusCode: 149675,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetHomeDataResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetHomeDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 20218,
|
||||
statusCode: 368241,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibrariesLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibrariesErrors](../models/getlibrarieserrors.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,52 +0,0 @@
|
||||
# GetLibrariesMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesMediaContainer = {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## 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` | [models.GetLibrariesDirectory](../models/getlibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,61 +0,0 @@
|
||||
# GetLibrariesResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibrariesResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 264555,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
updatedAt: 1705615634,
|
||||
createdAt: 1654131312,
|
||||
scannedAt: 1705615584,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 3192854,
|
||||
hidden: 0,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| `object` | [models.GetLibrariesResponseBody](../models/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetLibraryDirectory
|
||||
# GetLibraryDetailsDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDirectory } from "@lukehagar/plexjs";
|
||||
import { GetLibraryDetailsDirectory } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryDirectory = {
|
||||
let value: GetLibraryDetailsDirectory = {
|
||||
key: "search?type=1",
|
||||
title: "Search...",
|
||||
secondary: true,
|
||||
21
docs/models/getlibrarydetailserrors.md
Normal file
21
docs/models/getlibrarydetailserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetLibraryDetailsErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsErrors } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryDetailsErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 +1,11 @@
|
||||
# GetLibraryFilter
|
||||
# GetLibraryDetailsFilter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryFilter } from "@lukehagar/plexjs";
|
||||
import { GetLibraryDetailsFilter } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryFilter = {
|
||||
let value: GetLibraryDetailsFilter = {
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
18
docs/models/getlibrarydetailslibraryresponsebody.md
Normal file
18
docs/models/getlibrarydetailslibraryresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetLibraryDetailsLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `errors` | [models.GetLibraryDetailsErrors](../models/getlibrarydetailserrors.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 |
|
||||
97
docs/models/getlibrarydetailsmediacontainer.md
Normal file
97
docs/models/getlibrarydetailsmediacontainer.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# GetLibraryDetailsMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryDetailsMediaContainer = {
|
||||
size: 29,
|
||||
allowSync: false,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 1,
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1701731894,
|
||||
thumb: "/:/resources/movie.png",
|
||||
title1: "Movies",
|
||||
viewGroup: "secondary",
|
||||
viewMode: 65592,
|
||||
directory: [
|
||||
{
|
||||
key: "search?type=1",
|
||||
title: "Search...",
|
||||
secondary: true,
|
||||
prompt: "Search Movies",
|
||||
search: true,
|
||||
},
|
||||
],
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "resolution",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `content` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `directory` | [models.GetLibraryDetailsDirectory](../models/getlibrarydetailsdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `type` | [models.GetLibraryDetailsType](../models/getlibrarydetailstype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `fieldType` | [models.FieldType](../models/fieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,12 +1,12 @@
|
||||
# GetLibraryRequest
|
||||
# GetLibraryDetailsRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryRequest } from "@lukehagar/plexjs";
|
||||
import { GetLibraryDetailsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryRequest = {
|
||||
sectionId: 1000,
|
||||
let value: GetLibraryDetailsRequest = {
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -14,5 +14,5 @@ let value: GetLibraryRequest = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `includeDetails` | [models.IncludeDetails](../models/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
@@ -1,13 +1,13 @@
|
||||
# GetLibraryResponse
|
||||
# GetLibraryDetailsResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryResponse } from "@lukehagar/plexjs";
|
||||
import { GetLibraryDetailsResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryResponse = {
|
||||
let value: GetLibraryDetailsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 774234,
|
||||
statusCode: 902349,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -87,9 +87,9 @@ let value: GetLibraryResponse = {
|
||||
|
||||
## 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 |
|
||||
| `object` | [models.GetLibraryResponseBody](../models/getlibraryresponsebody.md) | :heavy_minus_sign: | The details of the library |
|
||||
| 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` | [models.GetLibraryDetailsResponseBody](../models/getlibrarydetailsresponsebody.md) | :heavy_minus_sign: | The details of the library |
|
||||
@@ -1,13 +1,13 @@
|
||||
# GetLibraryResponseBody
|
||||
# GetLibraryDetailsResponseBody
|
||||
|
||||
The details of the library
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
import { GetLibraryDetailsResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryResponseBody = {
|
||||
let value: GetLibraryDetailsResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 29,
|
||||
allowSync: false,
|
||||
@@ -82,6 +82,6 @@ let value: GetLibraryResponseBody = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetLibraryMediaContainer](../models/getlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetLibraryDetailsMediaContainer](../models/getlibrarydetailsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
53
docs/models/getlibrarydetailstype.md
Normal file
53
docs/models/getlibrarydetailstype.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# GetLibraryDetailsType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryDetailsType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryDetailsType = {
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## 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` | [models.GetLibraryDetailsFilter](../models/getlibrarydetailsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | [models.Sort](../models/sort.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetLibraryHubsRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryHubsRequest = {
|
||||
sectionId: 1433.53,
|
||||
sectionId: 2223.21,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetLibraryHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 537373,
|
||||
statusCode: 616934,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -3,19 +3,27 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs";
|
||||
import { GetLibraryItemsRequest, IncludeGuids, IncludeMeta, Tag, Type } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
sectionId: "<value>",
|
||||
tag: Tag.RecentlyViewed,
|
||||
includeGuids: 1,
|
||||
sectionKey: 9518,
|
||||
tag: Tag.Unwatched,
|
||||
includeGuids: IncludeGuids.One,
|
||||
includeMeta: IncludeMeta.One,
|
||||
type: Type.Two,
|
||||
xPlexContainerStart: 0,
|
||||
xPlexContainerSize: 50,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `sectionId` | *any* | :heavy_check_mark: | the Id of the library to query | |
|
||||
| `tag` | [models.Tag](../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `tag` | [models.Tag](../models/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `includeGuids` | [models.IncludeGuids](../models/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `includeMeta` | [models.IncludeMeta](../models/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `type` | [models.Type](../models/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetLibraryItemsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 135218,
|
||||
statusCode: 666767,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetLibraryLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetLibraryErrors](../models/getlibraryerrors.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,97 +0,0 @@
|
||||
# GetLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryMediaContainer = {
|
||||
size: 29,
|
||||
allowSync: false,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 1,
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1701731894,
|
||||
thumb: "/:/resources/movie.png",
|
||||
title1: "Movies",
|
||||
viewGroup: "secondary",
|
||||
viewMode: 65592,
|
||||
directory: [
|
||||
{
|
||||
key: "search?type=1",
|
||||
title: "Search...",
|
||||
secondary: true,
|
||||
prompt: "Search Movies",
|
||||
search: true,
|
||||
},
|
||||
],
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "resolution",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `content` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `viewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
|
||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `directory` | [models.GetLibraryDirectory](../models/getlibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `type` | [models.GetLibraryType](../models/getlibrarytype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `fieldType` | [models.FieldType](../models/fieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,53 +0,0 @@
|
||||
# GetLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetLibraryType = {
|
||||
key: "/library/sections/1/all?type=1",
|
||||
type: "movie",
|
||||
title: "Movies",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "label",
|
||||
filterType: "string",
|
||||
key: "/library/sections/1/label",
|
||||
title: "Labels",
|
||||
type: "filter",
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
defaultDirection: "desc",
|
||||
descKey: "random:desc",
|
||||
firstCharacterKey: "/library/sections/1/firstCharacter",
|
||||
key: "random",
|
||||
title: "Randomly",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "label",
|
||||
title: "Label",
|
||||
type: "tag",
|
||||
subType: "bitrate",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## 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` | [models.GetLibraryFilter](../models/getlibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | [models.Sort](../models/sort.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A | |
|
||||
28
docs/models/getmediaprovidersdirectory.md
Normal file
28
docs/models/getmediaprovidersdirectory.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# GetMediaProvidersDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersDirectory } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersDirectory = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `hubKey` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `agent` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `refreshing` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `scanner` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `scannedAt` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `pivot` | [models.Pivot](../models/pivot.md)[] | :heavy_minus_sign: | N/A |
|
||||
21
docs/models/getmediaproviderserrors.md
Normal file
21
docs/models/getmediaproviderserrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaProvidersErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersErrors } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
58
docs/models/getmediaprovidersmediacontainer.md
Normal file
58
docs/models/getmediaprovidersmediacontainer.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# GetMediaProvidersMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersMediaContainer } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersMediaContainer = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `allowCameraUpload` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `allowChannelAccess` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `allowSharing` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `allowTuners` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `backgroundProcessing` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `certificate` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `companionProxy` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `countryCode` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `diagnostics` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `eventStream` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `friendlyName` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `livetv` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `machineIdentifier` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `musicAnalysis` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `myPlex` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `myPlexMappingState` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `myPlexSigninState` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `myPlexSubscription` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `myPlexUsername` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `offlineTranscode` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `ownerFeatures` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `platform` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `platformVersion` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pluginHost` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `pushNotifications` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `readOnlyLibraries` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `streamingBrainABRVersion` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `streamingBrainVersion` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `sync` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderActiveVideoSessions` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderAudio` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderLyrics` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderSubtitles` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderVideo` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderVideoBitrates` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderVideoQualities` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `transcoderVideoResolutions` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `updater` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `version` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `voiceSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `mediaProvider` | [models.MediaProvider](../models/mediaprovider.md)[] | :heavy_minus_sign: | N/A |
|
||||
17
docs/models/getmediaprovidersrequest.md
Normal file
17
docs/models/getmediaprovidersrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetMediaProvidersRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersRequest = {
|
||||
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
24
docs/models/getmediaprovidersresponse.md
Normal file
24
docs/models/getmediaprovidersresponse.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetMediaProvidersResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 437587,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| `object` | [models.GetMediaProvidersResponseBody](../models/getmediaprovidersresponsebody.md) | :heavy_minus_sign: | Media providers and their features |
|
||||
17
docs/models/getmediaprovidersresponsebody.md
Normal file
17
docs/models/getmediaprovidersresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetMediaProvidersResponseBody
|
||||
|
||||
Media providers and their features
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMediaProvidersResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetMediaProvidersMediaContainer](../models/getmediaprovidersmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
18
docs/models/getmediaprovidersserverresponsebody.md
Normal file
18
docs/models/getmediaprovidersserverresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaProvidersServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaProvidersServerResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `errors` | [models.GetMediaProvidersErrors](../models/getmediaproviderserrors.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,11 +1,11 @@
|
||||
# GetMetadataCountry
|
||||
# GetMetaDataByRatingKeyCountry
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataCountry } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyCountry } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataCountry = {
|
||||
let value: GetMetaDataByRatingKeyCountry = {
|
||||
id: 116,
|
||||
filter: "country=116",
|
||||
tag: "United States of America",
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataDirector
|
||||
# GetMetaDataByRatingKeyDirector
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataDirector } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyDirector } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataDirector = {
|
||||
let value: GetMetaDataByRatingKeyDirector = {
|
||||
id: 130,
|
||||
filter: "director=130",
|
||||
tag: "Joss Whedon",
|
||||
21
docs/models/getmetadatabyratingkeyerrors.md
Normal file
21
docs/models/getmetadatabyratingkeyerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetaDataByRatingKeyErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## 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 +1,11 @@
|
||||
# GetMetadataGenre
|
||||
# GetMetaDataByRatingKeyGenre
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataGenre } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyGenre } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataGenre = {
|
||||
let value: GetMetaDataByRatingKeyGenre = {
|
||||
id: 184,
|
||||
filter: "genre=184",
|
||||
tag: "Thriller",
|
||||
18
docs/models/getmetadatabyratingkeylibraryresponsebody.md
Normal file
18
docs/models/getmetadatabyratingkeylibraryresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMetaDataByRatingKeyLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyLibraryResponseBody } from "@lukehagar/plexjs";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | [models.GetMetaDataByRatingKeyErrors](../models/getmetadatabyratingkeyerrors.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 |
|
||||
98
docs/models/getmetadatabyratingkeymedia.md
Normal file
98
docs/models/getmetadatabyratingkeymedia.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# GetMetaDataByRatingKeyMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetaDataByRatingKeyMedia = {
|
||||
id: 15,
|
||||
duration: 141417,
|
||||
bitrate: 2278,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
index: 0,
|
||||
bitrate: 128,
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "14520",
|
||||
codedHeight: 816,
|
||||
codedWidth: 1920,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
frameRate: 24,
|
||||
hasScalingMatrix: false,
|
||||
height: 814,
|
||||
level: 40,
|
||||
profile: "lc",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
streamIdentifier: "1",
|
||||
width: 1920,
|
||||
displayTitle: "English (AAC Stereo)",
|
||||
extendedDisplayTitle: "English (AAC Stereo)",
|
||||
selected: true,
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `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` | [models.GetMetaDataByRatingKeyPart](../models/getmetadatabyratingkeypart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,12 +1,12 @@
|
||||
# GetMetadataMediaContainer
|
||||
# GetMetaDataByRatingKeyMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataMediaContainer } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyMediaContainer } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetMetadataMediaContainer = {
|
||||
let value: GetMetaDataByRatingKeyMediaContainer = {
|
||||
size: 1,
|
||||
allowSync: true,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
@@ -182,14 +182,14 @@ let value: GetMetadataMediaContainer = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | [models.GetMetadataMetadata](../models/getmetadatametadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | [models.GetMetaDataByRatingKeyMetadata](../models/getmetadatabyratingkeymetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,12 +1,12 @@
|
||||
# GetMetadataMetadata
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataMetadata } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyMetadata } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetMetadataMetadata = {
|
||||
let value: GetMetaDataByRatingKeyMetadata = {
|
||||
ratingKey: "17",
|
||||
key: "/library/metadata/17",
|
||||
guid: "plex://movie/5d77683f6f4521001ea9dc53",
|
||||
@@ -196,12 +196,12 @@ let value: GetMetadataMetadata = {
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | [models.GetMetadataMedia](../models/getmetadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [models.GetMetadataGenre](../models/getmetadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [models.GetMetadataCountry](../models/getmetadatacountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `media` | [models.GetMetaDataByRatingKeyMedia](../models/getmetadatabyratingkeymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [models.GetMetaDataByRatingKeyGenre](../models/getmetadatabyratingkeygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [models.GetMetaDataByRatingKeyCountry](../models/getmetadatabyratingkeycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [models.Guids](../models/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | [models.Ratings](../models/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [models.GetMetadataDirector](../models/getmetadatadirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [models.GetMetadataWriter](../models/getmetadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [models.GetMetadataRole](../models/getmetadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [models.GetMetaDataByRatingKeyDirector](../models/getmetadatabyratingkeydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [models.GetMetaDataByRatingKeyWriter](../models/getmetadatabyratingkeywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [models.GetMetaDataByRatingKeyRole](../models/getmetadatabyratingkeyrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [models.Producer](../models/producer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataPart
|
||||
# GetMetaDataByRatingKeyPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataPart } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyPart } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataPart = {
|
||||
let value: GetMetaDataByRatingKeyPart = {
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
@@ -1,17 +1,17 @@
|
||||
# GetMetadataRequest
|
||||
# GetMetaDataByRatingKeyRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataRequest } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataRequest = {
|
||||
ratingKey: 6169.34,
|
||||
let value: GetMetaDataByRatingKeyRequest = {
|
||||
ratingKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetMetadataResponse
|
||||
# GetMetaDataByRatingKeyResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataResponse } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyResponse } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetMetadataResponse = {
|
||||
let value: GetMetaDataByRatingKeyResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 386489,
|
||||
statusCode: 358152,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -191,9 +191,9 @@ let value: GetMetadataResponse = {
|
||||
|
||||
## 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 |
|
||||
| `object` | [models.GetMetadataResponseBody](../models/getmetadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
| 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` | [models.GetMetaDataByRatingKeyResponseBody](../models/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetMetadataResponseBody
|
||||
# GetMetaDataByRatingKeyResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataResponseBody } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyResponseBody } from "@lukehagar/plexjs";
|
||||
import { RFCDate } from "@lukehagar/plexjs/types";
|
||||
|
||||
let value: GetMetadataResponseBody = {
|
||||
let value: GetMetaDataByRatingKeyResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 1,
|
||||
allowSync: true,
|
||||
@@ -186,6 +186,6 @@ let value: GetMetadataResponseBody = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [models.GetMetadataMediaContainer](../models/getmetadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [models.GetMetaDataByRatingKeyMediaContainer](../models/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataRole
|
||||
# GetMetaDataByRatingKeyRole
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataRole } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyRole } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataRole = {
|
||||
let value: GetMetaDataByRatingKeyRole = {
|
||||
id: 220,
|
||||
filter: "actor=220",
|
||||
tag: "Dennis Keiffer",
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetadataWriter
|
||||
# GetMetaDataByRatingKeyWriter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataWriter } from "@lukehagar/plexjs";
|
||||
import { GetMetaDataByRatingKeyWriter } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataWriter = {
|
||||
let value: GetMetaDataByRatingKeyWriter = {
|
||||
id: 132,
|
||||
filter: "writer=132",
|
||||
tag: "Joss Whedon",
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 9437.49,
|
||||
ratingKey: 1289.26,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 902599,
|
||||
statusCode: 750686,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,98 +0,0 @@
|
||||
# GetMetadataMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetadataMedia } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetMetadataMedia = {
|
||||
id: 15,
|
||||
duration: 141417,
|
||||
bitrate: 2278,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
index: 0,
|
||||
bitrate: 128,
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "14520",
|
||||
codedHeight: 816,
|
||||
codedWidth: 1920,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
frameRate: 24,
|
||||
hasScalingMatrix: false,
|
||||
height: 814,
|
||||
level: 40,
|
||||
profile: "lc",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
streamIdentifier: "1",
|
||||
width: 1920,
|
||||
displayTitle: "English (AAC Stereo)",
|
||||
extendedDisplayTitle: "English (AAC Stereo)",
|
||||
selected: true,
|
||||
channels: 2,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `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` | [models.GetMetadataPart](../models/getmetadatapart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -7,7 +7,7 @@ import { GetOnDeckResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetOnDeckResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 359508,
|
||||
statusCode: 607831,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -12,4 +12,4 @@ let value: GetPinGlobals = {};
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPinRequest } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPinRequest = {
|
||||
xPlexProduct: "Postman",
|
||||
xPlexProduct: "Plex Web",
|
||||
};
|
||||
```
|
||||
|
||||
@@ -15,5 +15,5 @@ let value: GetPinRequest = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
| `xPlexProduct` | *string* | :heavy_check_mark: | Product name of the application shown in the list of devices<br/> | Postman |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `xPlexProduct` | *string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
@@ -7,7 +7,7 @@ import { GetPinResponse } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPinResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 799159,
|
||||
statusCode: 135218,
|
||||
rawResponse: new Response('{"message": "hello world"}', {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
26
docs/models/getplaylistcontentsqueryparamtype.md
Normal file
26
docs/models/getplaylistcontentsqueryparamtype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetPlaylistContentsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs";
|
||||
|
||||
let value: GetPlaylistContentsQueryParamType = GetPlaylistContentsQueryParamType.Two;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `One` | 1 |
|
||||
| `Two` | 2 |
|
||||
| `Three` | 3 |
|
||||
| `Four` | 4 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user