Compare commits

...

17 Commits

Author SHA1 Message Date
speakeasybot
b9629abe33 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.134.0 2024-01-09 00:29:03 +00:00
speakeasybot
f306faa1ff ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.133.1 2024-01-05 19:51:55 +00:00
speakeasy-bot
e5abca0f3c 🐝 Add license. 2024-01-05 19:37:02 +00:00
speakeasy-bot
78acc1880a 🐝 Update gen.yaml 2024-01-05 19:37:01 +00:00
speakeasy-bot
a31aae3cd8 🐝 Update workflow file 2024-01-05 19:37:00 +00:00
speakeasybot
bc64130459 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.130.1 2024-01-05 00:28:28 +00:00
Luke Hagar
b553c6204c Update README.md 2024-01-01 09:24:42 -06:00
speakeasybot
9b02d27d5e ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:12:41 +00:00
Luke Hagar
f200bc563f Delete README.md 2024-01-01 09:10:23 -06:00
speakeasy-bot
5c4b98300b 🐝 Add license. 2024-01-01 15:09:39 +00:00
speakeasy-bot
1e46343716 🐝 Update gen.yaml 2024-01-01 15:09:39 +00:00
speakeasy-bot
c34f35ba3d 🐝 Update workflow file 2024-01-01 15:09:38 +00:00
speakeasybot
b77c4d818f ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:06:15 +00:00
Luke Hagar
ea6e427d7b Delete README.md 2024-01-01 09:01:36 -06:00
speakeasy-bot
4ed36cd1a2 🐝 Add license. 2024-01-01 14:36:24 +00:00
speakeasy-bot
1b0b5c218c 🐝 Update gen.yaml 2024-01-01 14:36:24 +00:00
speakeasy-bot
e92eb2ba92 🐝 Update workflow file 2024-01-01 14:36:23 +00:00
40 changed files with 779 additions and 261 deletions

478
.speakeasy/gen.lock Executable file
View File

@@ -0,0 +1,478 @@
lockVersion: 2.0.0
id: 16f22cbf-f23f-4419-8924-3a4b06381947
management:
docChecksum: 34d22936f2456c2c461abdfc773e3fc4
docVersion: 0.0.3
speakeasyVersion: internal
generationVersion: 2.230.1
releaseVersion: 0.3.2
configChecksum: 86f0aaf69f4406cb299c83cad9dc94fe
repoURL: https://github.com/LukeHagar/plexjs.git
repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexjs
published: true
features:
typescript:
core: 3.4.3
flattening: 2.81.1
globalSecurity: 2.82.2
globalServerURLs: 2.82.1
nameOverrides: 2.81.1
generatedFiles:
- src/sdk/server.ts
- src/sdk/media.ts
- src/sdk/activities.ts
- src/sdk/butler.ts
- src/sdk/hubs.ts
- src/sdk/search.ts
- src/sdk/library.ts
- src/sdk/log.ts
- src/sdk/playlists.ts
- src/sdk/security.ts
- src/sdk/sessions.ts
- src/sdk/updater.ts
- src/sdk/video.ts
- src/sdk/sdk.ts
- .eslintrc.js
- .npmignore
- package-lock.json
- package.json
- src/index.ts
- src/lib/base64.ts
- src/lib/config.ts
- src/lib/encodings.ts
- src/lib/http.ts
- src/lib/retries.ts
- src/lib/sdks.ts
- src/lib/security.ts
- src/lib/url.ts
- src/sdk/index.ts
- src/models/errors/sdkerror.ts
- src/types/blobs.ts
- src/types/decimal.ts
- src/types/index.ts
- src/types/operations.ts
- src/types/rfcdate.ts
- tsconfig.json
- src/models/operations/getservercapabilities.ts
- src/models/operations/getserverpreferences.ts
- src/models/operations/getavailableclients.ts
- src/models/operations/getdevices.ts
- src/models/operations/getserveridentity.ts
- src/models/operations/getmyplexaccount.ts
- src/models/operations/getresizedphoto.ts
- src/models/operations/getserverlist.ts
- src/models/operations/markplayed.ts
- src/models/operations/markunplayed.ts
- src/models/operations/updateplayprogress.ts
- src/models/operations/getserveractivities.ts
- src/models/operations/cancelserveractivities.ts
- src/models/operations/getbutlertasks.ts
- src/models/operations/startalltasks.ts
- src/models/operations/stopalltasks.ts
- src/models/operations/starttask.ts
- src/models/operations/stoptask.ts
- src/models/operations/getglobalhubs.ts
- src/models/operations/getlibraryhubs.ts
- src/models/operations/performsearch.ts
- src/models/operations/performvoicesearch.ts
- src/models/operations/getsearchresults.ts
- src/models/operations/getfilehash.ts
- src/models/operations/getrecentlyadded.ts
- src/models/operations/getlibraries.ts
- src/models/operations/getlibrary.ts
- src/models/operations/deletelibrary.ts
- src/models/operations/getlibraryitems.ts
- src/models/operations/refreshlibrary.ts
- src/models/operations/getlatestlibraryitems.ts
- src/models/operations/getcommonlibraryitems.ts
- src/models/operations/getmetadata.ts
- src/models/operations/getmetadatachildren.ts
- src/models/operations/getondeck.ts
- src/models/operations/logline.ts
- src/models/operations/logmultiline.ts
- src/models/operations/enablepapertrail.ts
- src/models/operations/createplaylist.ts
- src/models/operations/getplaylists.ts
- src/models/operations/getplaylist.ts
- src/models/operations/deleteplaylist.ts
- src/models/operations/updateplaylist.ts
- src/models/operations/getplaylistcontents.ts
- src/models/operations/clearplaylistcontents.ts
- src/models/operations/addplaylistcontents.ts
- src/models/operations/uploadplaylist.ts
- src/models/operations/gettransienttoken.ts
- src/models/operations/getsourceconnectioninformation.ts
- src/models/operations/getsessions.ts
- src/models/operations/getsessionhistory.ts
- src/models/operations/gettranscodesessions.ts
- src/models/operations/stoptranscodesession.ts
- src/models/operations/getupdatestatus.ts
- src/models/operations/checkforupdates.ts
- src/models/operations/applyupdates.ts
- src/models/operations/startuniversaltranscode.ts
- src/models/operations/gettimeline.ts
- src/models/errors/getservercapabilities.ts
- src/models/errors/getserverpreferences.ts
- src/models/errors/getavailableclients.ts
- src/models/errors/getdevices.ts
- src/models/errors/getserveridentity.ts
- src/models/errors/getmyplexaccount.ts
- src/models/errors/getresizedphoto.ts
- src/models/errors/getserverlist.ts
- src/models/errors/markplayed.ts
- src/models/errors/markunplayed.ts
- src/models/errors/updateplayprogress.ts
- src/models/errors/getserveractivities.ts
- src/models/errors/cancelserveractivities.ts
- src/models/errors/getbutlertasks.ts
- src/models/errors/startalltasks.ts
- src/models/errors/stopalltasks.ts
- src/models/errors/starttask.ts
- src/models/errors/stoptask.ts
- src/models/errors/getglobalhubs.ts
- src/models/errors/getlibraryhubs.ts
- src/models/errors/performsearch.ts
- src/models/errors/performvoicesearch.ts
- src/models/errors/getsearchresults.ts
- src/models/errors/getfilehash.ts
- src/models/errors/getrecentlyadded.ts
- src/models/errors/getlibraries.ts
- src/models/errors/getlibrary.ts
- src/models/errors/deletelibrary.ts
- src/models/errors/getlibraryitems.ts
- src/models/errors/refreshlibrary.ts
- src/models/errors/getlatestlibraryitems.ts
- src/models/errors/getcommonlibraryitems.ts
- src/models/errors/getmetadata.ts
- src/models/errors/getmetadatachildren.ts
- src/models/errors/getondeck.ts
- src/models/errors/logline.ts
- src/models/errors/logmultiline.ts
- src/models/errors/enablepapertrail.ts
- src/models/errors/createplaylist.ts
- src/models/errors/getplaylists.ts
- src/models/errors/getplaylist.ts
- src/models/errors/deleteplaylist.ts
- src/models/errors/updateplaylist.ts
- src/models/errors/getplaylistcontents.ts
- src/models/errors/clearplaylistcontents.ts
- src/models/errors/addplaylistcontents.ts
- src/models/errors/uploadplaylist.ts
- src/models/errors/gettransienttoken.ts
- src/models/errors/getsourceconnectioninformation.ts
- src/models/errors/getsessions.ts
- src/models/errors/getsessionhistory.ts
- src/models/errors/gettranscodesessions.ts
- src/models/errors/stoptranscodesession.ts
- src/models/errors/getupdatestatus.ts
- src/models/errors/checkforupdates.ts
- src/models/errors/applyupdates.ts
- src/models/errors/startuniversaltranscode.ts
- src/models/errors/gettimeline.ts
- src/models/components/security.ts
- src/models/errors/index.ts
- src/models/operations/index.ts
- src/models/components/index.ts
- docs/models/operations/directory.md
- docs/models/operations/mediacontainer.md
- docs/models/operations/getservercapabilitiesresponsebody.md
- docs/models/operations/getservercapabilitiesresponse.md
- docs/models/operations/getserverpreferencesresponse.md
- docs/models/operations/server.md
- docs/models/operations/getavailableclientsmediacontainer.md
- docs/models/operations/responsebody.md
- docs/models/operations/getavailableclientsresponse.md
- docs/models/operations/device.md
- docs/models/operations/getdevicesmediacontainer.md
- docs/models/operations/getdevicesresponsebody.md
- docs/models/operations/getdevicesresponse.md
- docs/models/operations/getserveridentitymediacontainer.md
- docs/models/operations/getserveridentityresponsebody.md
- docs/models/operations/getserveridentityresponse.md
- docs/models/operations/myplex.md
- docs/models/operations/getmyplexaccountresponsebody.md
- docs/models/operations/getmyplexaccountresponse.md
- docs/models/operations/minsize.md
- docs/models/operations/upscale.md
- docs/models/operations/getresizedphotorequest.md
- docs/models/operations/getresizedphotoresponse.md
- docs/models/operations/getserverlistserver.md
- docs/models/operations/getserverlistmediacontainer.md
- docs/models/operations/getserverlistresponsebody.md
- docs/models/operations/getserverlistresponse.md
- docs/models/operations/markplayedrequest.md
- docs/models/operations/markplayedresponse.md
- docs/models/operations/markunplayedrequest.md
- docs/models/operations/markunplayedresponse.md
- docs/models/operations/updateplayprogressrequest.md
- docs/models/operations/updateplayprogressresponse.md
- docs/models/operations/context.md
- docs/models/operations/activity.md
- docs/models/operations/getserveractivitiesmediacontainer.md
- docs/models/operations/getserveractivitiesresponsebody.md
- docs/models/operations/getserveractivitiesresponse.md
- docs/models/operations/cancelserveractivitiesrequest.md
- docs/models/operations/cancelserveractivitiesresponse.md
- docs/models/operations/butlertask.md
- docs/models/operations/butlertasks.md
- docs/models/operations/getbutlertasksresponsebody.md
- docs/models/operations/getbutlertasksresponse.md
- docs/models/operations/startalltasksresponse.md
- docs/models/operations/stopalltasksresponse.md
- docs/models/operations/taskname.md
- docs/models/operations/starttaskrequest.md
- docs/models/operations/starttaskresponse.md
- docs/models/operations/pathparamtaskname.md
- docs/models/operations/stoptaskrequest.md
- docs/models/operations/stoptaskresponse.md
- docs/models/operations/onlytransient.md
- docs/models/operations/getglobalhubsrequest.md
- docs/models/operations/getglobalhubsresponse.md
- docs/models/operations/queryparamonlytransient.md
- docs/models/operations/getlibraryhubsrequest.md
- docs/models/operations/getlibraryhubsresponse.md
- docs/models/operations/performsearchrequest.md
- docs/models/operations/performsearchresponse.md
- docs/models/operations/performvoicesearchrequest.md
- docs/models/operations/performvoicesearchresponse.md
- docs/models/operations/getsearchresultsrequest.md
- docs/models/operations/getsearchresultspart.md
- docs/models/operations/getsearchresultsmedia.md
- docs/models/operations/getsearchresultsgenre.md
- docs/models/operations/getsearchresultsdirector.md
- docs/models/operations/getsearchresultswriter.md
- docs/models/operations/getsearchresultscountry.md
- docs/models/operations/getsearchresultsrole.md
- docs/models/operations/getsearchresultsmetadata.md
- docs/models/operations/provider.md
- docs/models/operations/getsearchresultsmediacontainer.md
- docs/models/operations/getsearchresultsresponsebody.md
- docs/models/operations/getsearchresultsresponse.md
- docs/models/operations/getfilehashrequest.md
- docs/models/operations/getfilehashresponse.md
- docs/models/operations/part.md
- docs/models/operations/media.md
- docs/models/operations/genre.md
- docs/models/operations/director.md
- docs/models/operations/writer.md
- docs/models/operations/country.md
- docs/models/operations/role.md
- docs/models/operations/metadata.md
- docs/models/operations/getrecentlyaddedmediacontainer.md
- docs/models/operations/getrecentlyaddedresponsebody.md
- docs/models/operations/getrecentlyaddedresponse.md
- docs/models/operations/getlibrariesresponse.md
- docs/models/operations/includedetails.md
- docs/models/operations/getlibraryrequest.md
- docs/models/operations/getlibraryresponse.md
- docs/models/operations/deletelibraryrequest.md
- docs/models/operations/deletelibraryresponse.md
- docs/models/operations/getlibraryitemsrequest.md
- docs/models/operations/getlibraryitemsresponse.md
- docs/models/operations/refreshlibraryrequest.md
- docs/models/operations/refreshlibraryresponse.md
- docs/models/operations/getlatestlibraryitemsrequest.md
- docs/models/operations/getlatestlibraryitemsresponse.md
- docs/models/operations/getcommonlibraryitemsrequest.md
- docs/models/operations/getcommonlibraryitemsresponse.md
- docs/models/operations/getmetadatarequest.md
- docs/models/operations/getmetadataresponse.md
- docs/models/operations/getmetadatachildrenrequest.md
- docs/models/operations/getmetadatachildrenresponse.md
- docs/models/operations/stream.md
- docs/models/operations/getondeckpart.md
- docs/models/operations/getondeckmedia.md
- docs/models/operations/guids.md
- docs/models/operations/getondeckmetadata.md
- docs/models/operations/getondeckmediacontainer.md
- docs/models/operations/getondeckresponsebody.md
- docs/models/operations/getondeckresponse.md
- docs/models/operations/level.md
- docs/models/operations/loglinerequest.md
- docs/models/operations/loglineresponse.md
- docs/models/operations/logmultilineresponse.md
- docs/models/operations/enablepapertrailresponse.md
- docs/models/operations/typet.md
- docs/models/operations/smart.md
- docs/models/operations/createplaylistrequest.md
- docs/models/operations/createplaylistresponse.md
- docs/models/operations/playlisttype.md
- docs/models/operations/queryparamsmart.md
- docs/models/operations/getplaylistsrequest.md
- docs/models/operations/getplaylistsresponse.md
- docs/models/operations/getplaylistrequest.md
- docs/models/operations/getplaylistresponse.md
- docs/models/operations/deleteplaylistrequest.md
- docs/models/operations/deleteplaylistresponse.md
- docs/models/operations/updateplaylistrequest.md
- docs/models/operations/updateplaylistresponse.md
- docs/models/operations/getplaylistcontentsrequest.md
- docs/models/operations/getplaylistcontentsresponse.md
- docs/models/operations/clearplaylistcontentsrequest.md
- docs/models/operations/clearplaylistcontentsresponse.md
- docs/models/operations/addplaylistcontentsrequest.md
- docs/models/operations/addplaylistcontentsresponse.md
- docs/models/operations/force.md
- docs/models/operations/uploadplaylistrequest.md
- docs/models/operations/uploadplaylistresponse.md
- docs/models/operations/queryparamtype.md
- docs/models/operations/scope.md
- docs/models/operations/gettransienttokenrequest.md
- docs/models/operations/gettransienttokenresponse.md
- docs/models/operations/getsourceconnectioninformationrequest.md
- docs/models/operations/getsourceconnectioninformationresponse.md
- docs/models/operations/getsessionsresponse.md
- docs/models/operations/getsessionhistoryresponse.md
- docs/models/operations/transcodesession.md
- docs/models/operations/gettranscodesessionsmediacontainer.md
- docs/models/operations/gettranscodesessionsresponsebody.md
- docs/models/operations/gettranscodesessionsresponse.md
- docs/models/operations/stoptranscodesessionrequest.md
- docs/models/operations/stoptranscodesessionresponse.md
- docs/models/operations/getupdatestatusresponse.md
- docs/models/operations/download.md
- docs/models/operations/checkforupdatesrequest.md
- docs/models/operations/checkforupdatesresponse.md
- docs/models/operations/tonight.md
- docs/models/operations/skip.md
- docs/models/operations/applyupdatesrequest.md
- docs/models/operations/applyupdatesresponse.md
- docs/models/operations/startuniversaltranscoderequest.md
- docs/models/operations/startuniversaltranscoderesponse.md
- docs/models/operations/state.md
- docs/models/operations/gettimelinerequest.md
- docs/models/operations/gettimelineresponse.md
- docs/models/errors/errors.md
- docs/models/errors/getservercapabilitiesresponsebody.md
- docs/models/errors/getserverpreferenceserrors.md
- docs/models/errors/getserverpreferencesresponsebody.md
- docs/models/errors/getavailableclientserrors.md
- docs/models/errors/getavailableclientsresponsebody.md
- docs/models/errors/getdeviceserrors.md
- docs/models/errors/getdevicesresponsebody.md
- docs/models/errors/getserveridentityerrors.md
- docs/models/errors/getserveridentityresponsebody.md
- docs/models/errors/getmyplexaccounterrors.md
- docs/models/errors/getmyplexaccountresponsebody.md
- docs/models/errors/getresizedphotoerrors.md
- docs/models/errors/getresizedphotoresponsebody.md
- docs/models/errors/getserverlisterrors.md
- docs/models/errors/getserverlistresponsebody.md
- docs/models/errors/markplayederrors.md
- docs/models/errors/markplayedresponsebody.md
- docs/models/errors/markunplayederrors.md
- docs/models/errors/markunplayedresponsebody.md
- docs/models/errors/updateplayprogresserrors.md
- docs/models/errors/updateplayprogressresponsebody.md
- docs/models/errors/getserveractivitieserrors.md
- docs/models/errors/getserveractivitiesresponsebody.md
- docs/models/errors/cancelserveractivitieserrors.md
- docs/models/errors/cancelserveractivitiesresponsebody.md
- docs/models/errors/getbutlertaskserrors.md
- docs/models/errors/getbutlertasksresponsebody.md
- docs/models/errors/startalltaskserrors.md
- docs/models/errors/startalltasksresponsebody.md
- docs/models/errors/stopalltaskserrors.md
- docs/models/errors/stopalltasksresponsebody.md
- docs/models/errors/starttaskerrors.md
- docs/models/errors/starttaskresponsebody.md
- docs/models/errors/stoptaskerrors.md
- docs/models/errors/stoptaskresponsebody.md
- docs/models/errors/getglobalhubserrors.md
- docs/models/errors/getglobalhubsresponsebody.md
- docs/models/errors/getlibraryhubserrors.md
- docs/models/errors/getlibraryhubsresponsebody.md
- docs/models/errors/performsearcherrors.md
- docs/models/errors/performsearchresponsebody.md
- docs/models/errors/performvoicesearcherrors.md
- docs/models/errors/performvoicesearchresponsebody.md
- docs/models/errors/getsearchresultserrors.md
- docs/models/errors/getsearchresultsresponsebody.md
- docs/models/errors/getfilehasherrors.md
- docs/models/errors/getfilehashresponsebody.md
- docs/models/errors/getrecentlyaddederrors.md
- docs/models/errors/getrecentlyaddedresponsebody.md
- docs/models/errors/getlibrarieserrors.md
- docs/models/errors/getlibrariesresponsebody.md
- docs/models/errors/getlibraryerrors.md
- docs/models/errors/getlibraryresponsebody.md
- docs/models/errors/deletelibraryerrors.md
- docs/models/errors/deletelibraryresponsebody.md
- docs/models/errors/getlibraryitemserrors.md
- docs/models/errors/getlibraryitemsresponsebody.md
- docs/models/errors/refreshlibraryerrors.md
- docs/models/errors/refreshlibraryresponsebody.md
- docs/models/errors/getlatestlibraryitemserrors.md
- docs/models/errors/getlatestlibraryitemsresponsebody.md
- docs/models/errors/getcommonlibraryitemserrors.md
- docs/models/errors/getcommonlibraryitemsresponsebody.md
- docs/models/errors/getmetadataerrors.md
- docs/models/errors/getmetadataresponsebody.md
- docs/models/errors/getmetadatachildrenerrors.md
- docs/models/errors/getmetadatachildrenresponsebody.md
- docs/models/errors/getondeckerrors.md
- docs/models/errors/getondeckresponsebody.md
- docs/models/errors/loglineerrors.md
- docs/models/errors/loglineresponsebody.md
- docs/models/errors/logmultilineerrors.md
- docs/models/errors/logmultilineresponsebody.md
- docs/models/errors/enablepapertrailerrors.md
- docs/models/errors/enablepapertrailresponsebody.md
- docs/models/errors/createplaylisterrors.md
- docs/models/errors/createplaylistresponsebody.md
- docs/models/errors/getplaylistserrors.md
- docs/models/errors/getplaylistsresponsebody.md
- docs/models/errors/getplaylisterrors.md
- docs/models/errors/getplaylistresponsebody.md
- docs/models/errors/deleteplaylisterrors.md
- docs/models/errors/deleteplaylistresponsebody.md
- docs/models/errors/updateplaylisterrors.md
- docs/models/errors/updateplaylistresponsebody.md
- docs/models/errors/getplaylistcontentserrors.md
- docs/models/errors/getplaylistcontentsresponsebody.md
- docs/models/errors/clearplaylistcontentserrors.md
- docs/models/errors/clearplaylistcontentsresponsebody.md
- docs/models/errors/addplaylistcontentserrors.md
- docs/models/errors/addplaylistcontentsresponsebody.md
- docs/models/errors/uploadplaylisterrors.md
- docs/models/errors/uploadplaylistresponsebody.md
- docs/models/errors/gettransienttokenerrors.md
- docs/models/errors/gettransienttokenresponsebody.md
- docs/models/errors/getsourceconnectioninformationerrors.md
- docs/models/errors/getsourceconnectioninformationresponsebody.md
- docs/models/errors/getsessionserrors.md
- docs/models/errors/getsessionsresponsebody.md
- docs/models/errors/getsessionhistoryerrors.md
- docs/models/errors/getsessionhistoryresponsebody.md
- docs/models/errors/gettranscodesessionserrors.md
- docs/models/errors/gettranscodesessionsresponsebody.md
- docs/models/errors/stoptranscodesessionerrors.md
- docs/models/errors/stoptranscodesessionresponsebody.md
- docs/models/errors/getupdatestatuserrors.md
- docs/models/errors/getupdatestatusresponsebody.md
- docs/models/errors/checkforupdateserrors.md
- docs/models/errors/checkforupdatesresponsebody.md
- docs/models/errors/applyupdateserrors.md
- docs/models/errors/applyupdatesresponsebody.md
- docs/models/errors/startuniversaltranscodeerrors.md
- docs/models/errors/startuniversaltranscoderesponsebody.md
- docs/models/errors/gettimelineerrors.md
- docs/models/errors/gettimelineresponsebody.md
- docs/models/components/security.md
- docs/sdks/plexapi/README.md
- docs/sdks/server/README.md
- docs/sdks/media/README.md
- docs/sdks/activities/README.md
- docs/sdks/butler/README.md
- docs/sdks/hubs/README.md
- docs/sdks/search/README.md
- docs/sdks/library/README.md
- docs/sdks/log/README.md
- docs/sdks/playlists/README.md
- docs/sdks/security/README.md
- docs/sdks/sessions/README.md
- docs/sdks/updater/README.md
- docs/sdks/video/README.md
- USAGE.md
- .gitattributes

View File

@@ -1,4 +1,4 @@
# openapi
# @lukehagar/plexjs
<div align="left">
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -7,28 +7,19 @@
</a>
</div>
## 🏗 **Welcome to your new SDK!** 🏗
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
<!-- Start SDK Installation [installation] -->
## SDK Installation
### NPM
```bash
npm add openapi
npm add @lukehagar/plexjs
```
### Yarn
```bash
yarn add openapi
yarn add @lukehagar/plexjs
```
<!-- End SDK Installation [installation] -->
@@ -38,10 +29,10 @@ yarn add openapi
### Example
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -173,11 +164,11 @@ All SDK methods return a response object or throw an error. If Error objects are
Example
```typescript
import { SDK } from "openapi";
import * as errors from "openapi/models/errors";
import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/models/errors";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -211,8 +202,7 @@ You can override the default server globally by passing a server index to the `s
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `http://10.10.10.47:32400` | None |
| 1 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
@@ -246,8 +236,8 @@ custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors:
```typescript
import { SDK } from "openapi";
import { HTTPClient } from "openapi/lib/http";
import { PlexAPI } from "@lukehagar/plexjs";
import { HTTPClient } from "@lukehagar/plexjs/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
@@ -273,7 +263,7 @@ httpClient.addHook("requestError", (error, request) => {
console.groupEnd();
});
const sdk = new SDK({ httpClient });
const sdk = new PlexAPI({ httpClient });
```
<!-- End Custom HTTP Client [http-client] -->
@@ -290,10 +280,10 @@ This SDK supports the following security scheme globally:
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -8,4 +8,54 @@ Based on:
### Generated
- [typescript v0.1.0] .
### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - .
- [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - .
## 2024-01-01 15:05:18
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.2.0] .
### Releases
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
## 2024-01-01 15:11:44
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
## 2024-01-05 00:27:32
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.130.1 (2.225.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
## 2024-01-05 19:51:02
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.1] .
### Releases
- [NPM v0.3.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.1 - .
## 2024-01-09 00:28:08
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.134.0 (2.230.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.2] .
### Releases
- [NPM v0.3.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.2 - .

View File

@@ -1,9 +1,9 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -24,10 +24,10 @@ Get Server Activities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -68,10 +68,10 @@ Cancel Server Activities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -21,10 +21,10 @@ Returns a list of butler tasks
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -70,10 +70,10 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -115,10 +115,10 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -164,11 +164,11 @@ This endpoint will attempt to start a single Butler task that is enabled in the
### Example Usage
```typescript
import { SDK } from "openapi";
import { TaskName } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -213,11 +213,11 @@ This endpoint will stop a currently running task by name, or remove it from the
### Example Usage
```typescript
import { SDK } from "openapi";
import { PathParamTaskName } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -18,11 +18,11 @@ Get Global Hubs filtered by the parameters provided.
### Example Usage
```typescript
import { SDK } from "openapi";
import { OnlyTransient } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -69,11 +69,11 @@ This endpoint will return a list of library specific hubs
### Example Usage
```typescript
import { SDK } from "openapi";
import { QueryParamOnlyTransient } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -28,10 +28,10 @@ This resource returns hash values for local files
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -78,10 +78,10 @@ This endpoint will return the recently added content.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -128,10 +128,10 @@ This allows a client to provide a rich interface around the media (e.g. allow so
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -191,11 +191,11 @@ Returns details for the library. This can be thought of as an interstitial endpo
### Example Usage
```typescript
import { SDK } from "openapi";
import { IncludeDetails } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -241,10 +241,10 @@ Delate a library using a specific section
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -289,10 +289,10 @@ This endpoint will return a list of library items filtered by the filter and typ
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -341,10 +341,10 @@ This endpoint Refreshes the library.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -389,10 +389,10 @@ This endpoint will return a list of the latest library items filtered by the fil
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -441,10 +441,10 @@ Represents a "Common" item. It contains only the common attributes of the items
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -493,10 +493,10 @@ This endpoint will return the metadata of a library item specified with the rati
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -541,10 +541,10 @@ This endpoint will return the children of of a library item specified with the r
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -589,10 +589,10 @@ This endpoint will return the on deck content.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -20,11 +20,11 @@ This endpoint will write a single-line log message, including a level and source
### Example Usage
```typescript
import { SDK } from "openapi";
import { Level } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { Level } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -73,10 +73,10 @@ This endpoint will write multiple lines to the main Plex Media Server log in a s
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -118,10 +118,10 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -19,10 +19,10 @@ This will mark the provided media key as Played.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -66,10 +66,10 @@ This will mark the provided media key as Unplayed.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -114,10 +114,10 @@ This API command can be used to update the play progress of a media item.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -31,11 +31,11 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
### Example Usage
```typescript
import { SDK } from "openapi";
import { Smart, TypeT } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { Smart, TypeT } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -81,11 +81,11 @@ Get All Playlists given the specified filters.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlaylistType, QueryParamSmart } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -133,10 +133,10 @@ Smart playlist details contain the `content` attribute. This is the content URI
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -181,10 +181,10 @@ This endpoint will delete a playlist
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -229,10 +229,10 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -280,10 +280,10 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -330,10 +330,10 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -379,10 +379,10 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -431,11 +431,11 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
### Example Usage
```typescript
import { SDK } from "openapi";
import { Force } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { Force } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -1,4 +1,4 @@
# SDK
# PlexAPI SDK
## Overview

View File

@@ -31,10 +31,10 @@ This request is intended to be very fast, and called as the user types.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -86,10 +86,10 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -137,10 +137,10 @@ This will search the database for the string provided.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -19,11 +19,11 @@ This endpoint provides the caller with a temporary token with the same access le
### Example Usage
```typescript
import { SDK } from "openapi";
import { QueryParamType, Scope } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -71,10 +71,10 @@ Note: requires Plex Media Server >= 1.15.4.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -24,10 +24,10 @@ Server Capabilities
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -68,10 +68,10 @@ Get Server Preferences
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -112,10 +112,10 @@ Get Available Clients
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -156,10 +156,10 @@ Get Devices
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -200,10 +200,10 @@ Get Server Identity
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -244,10 +244,10 @@ Returns MyPlex Account Information
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -289,11 +289,11 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
### Example Usage
```typescript
import { SDK } from "openapi";
import { MinSize, Upscale } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -343,10 +343,10 @@ Get Server List
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -20,10 +20,10 @@ This will retrieve the "Now Playing" Information of the PMS.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -64,10 +64,10 @@ This will Retrieve a listing of all history views.
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -108,10 +108,10 @@ Get Transcode Sessions
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -152,10 +152,10 @@ Stop a Transcode Session
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -20,10 +20,10 @@ Querying status of updates
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -64,11 +64,11 @@ Checking for updates
### Example Usage
```typescript
import { SDK } from "openapi";
import { Download } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { Download } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -113,11 +113,11 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
### Example Usage
```typescript
import { SDK } from "openapi";
import { Skip, Tonight } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -18,10 +18,10 @@ Begin a Universal Transcode Session
### Example Usage
```typescript
import { SDK } from "openapi";
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
@@ -69,11 +69,11 @@ Get the timeline for a media item
### Example Usage
```typescript
import { SDK } from "openapi";
import { State } from "openapi/models/operations";
import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "@lukehagar/plexjs/models/operations";
async function run() {
const sdk = new SDK({
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});

View File

@@ -439,7 +439,7 @@ docs/models/errors/startuniversaltranscoderesponsebody.md
docs/models/errors/gettimelineerrors.md
docs/models/errors/gettimelineresponsebody.md
docs/models/components/security.md
docs/sdks/sdk/README.md
docs/sdks/plexapi/README.md
docs/sdks/server/README.md
docs/sdks/media/README.md
docs/sdks/activities/README.md

View File

@@ -1,29 +1,15 @@
configVersion: 1.0.0
management:
docChecksum: 550154cf1b4d0c237436fb18c418b5db
docVersion: 0.0.3
speakeasyVersion: 1.129.1
generationVersion: 2.223.3
configVersion: 2.0.0
generation:
comments: {}
sdkClassName: SDK
repoURL: https://github.com/LukeHagar/plexjs.git
sdkClassName: Plex-API
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
fixes:
nameResolutionDec2023: true
useClassNamesForArrayFields: true
features:
typescript:
core: 3.3.12
flattening: 2.81.1
globalSecurity: 2.82.2
globalServerURLs: 2.82.1
nameOverrides: 2.81.1
fixes:
nameResolutionDec2023: false
typescript:
version: 0.1.0
author: Speakeasy
version: 0.3.2
author: LukeHagar
clientServerStatusCodesAsErrors: true
flattenGlobalSecurity: true
imports:
@@ -35,10 +21,7 @@ typescript:
shared: models/components
webhooks: models/webhooks
inputModelSuffix: input
installationURL: https://github.com/LukeHagar/plexjs
maxMethodParams: 4
outputModelSuffix: output
packageName: openapi
published: true
repoSubDirectory: .
packageName: '@lukehagar/plexjs'
templateVersion: v2

8
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "openapi",
"version": "0.1.0",
"name": "@lukehagar/plexjs",
"version": "0.3.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "openapi",
"version": "0.1.0",
"name": "@lukehagar/plexjs",
"version": "0.3.2",
"dependencies": {
"decimal.js": "^10.4.3",
"jsonpath": "^1.1.1"

View File

@@ -1,8 +1,8 @@
{
"type": "commonjs",
"name": "openapi",
"version": "0.1.0",
"author": "Speakeasy",
"name": "@lukehagar/plexjs",
"version": "0.3.2",
"author": "LukeHagar",
"main": "./index.js",
"sideEffects": false,
"repository": {

View File

@@ -10,10 +10,6 @@ import { RetryConfig } from "./retries";
* Contains the list of servers available to the SDK
*/
export const ServerList = [
/**
* The full address of your Plex Server
*/
"http://10.10.10.47:32400",
/**
* The full address of your Plex Server
*/
@@ -62,7 +58,6 @@ export function serverURLFromOptions(options: SDKOptions): URL {
let serverURL = options.serverURL;
const serverParams = [
{},
{
protocol: options.protocol?.toString() ?? "http",
ip: options.ip?.toString() ?? "10.10.10.47",
@@ -84,7 +79,7 @@ export function serverURLFromOptions(options: SDKOptions): URL {
export const SDK_METADATA = Object.freeze({
language: "typescript",
openapiDocVersion: "0.0.3",
sdkVersion: "0.1.0",
genVersion: "2.223.3",
userAgent: "speakeasy-sdk/typescript 0.1.0 2.223.3 0.0.3 openapi",
sdkVersion: "0.3.2",
genVersion: "2.230.1",
userAgent: "speakeasy-sdk/typescript 0.3.2 2.230.1 0.0.3 @lukehagar/plexjs",
});

View File

@@ -7,6 +7,8 @@ export type Fetcher = (
init?: RequestInit,
) => Promise<Response>;
const DEFAULT_FETCHER: Fetcher = (input, init) => fetch(input, init);
export interface HTTPClientOptions {
fetcher?: Fetcher;
}
@@ -22,7 +24,7 @@ export class HTTPClient {
private responseHooks: ResponseHook[] = [];
constructor(private options: HTTPClientOptions = {}) {
this.fetcher = options.fetcher || fetch;
this.fetcher = options.fetcher || DEFAULT_FETCHER;
}
async request(request: Request): Promise<Response> {

View File

@@ -47,7 +47,7 @@ export class Activities extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -119,7 +119,7 @@ export class Activities extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,

View File

@@ -45,7 +45,7 @@ export class Butler extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -104,7 +104,7 @@ export class Butler extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "post", path: path$, headers: headers$ },
{ security: securitySettings$, method: "POST", path: path$, headers: headers$ },
options
);
@@ -156,7 +156,7 @@ export class Butler extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "delete", path: path$, headers: headers$ },
{ security: securitySettings$, method: "DELETE", path: path$, headers: headers$ },
options
);
@@ -230,7 +230,7 @@ export class Butler extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "post",
method: "POST",
path: path$,
headers: headers$,
body: body$,
@@ -304,7 +304,7 @@ export class Butler extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,

View File

@@ -68,7 +68,7 @@ export class Hubs extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -157,7 +157,7 @@ export class Hubs extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,

View File

@@ -65,7 +65,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -122,7 +122,7 @@ export class Library extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -182,7 +182,7 @@ export class Library extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -281,7 +281,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -355,7 +355,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,
@@ -440,7 +440,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -517,7 +517,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
body: body$,
@@ -604,7 +604,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -692,7 +692,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -767,7 +767,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
body: body$,
@@ -843,7 +843,7 @@ export class Library extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
body: body$,
@@ -899,7 +899,7 @@ export class Library extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);

View File

@@ -72,7 +72,7 @@ export class Log extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -129,7 +129,7 @@ export class Log extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "post", path: path$, headers: headers$ },
{ security: securitySettings$, method: "POST", path: path$, headers: headers$ },
options
);
@@ -181,7 +181,7 @@ export class Log extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);

View File

@@ -62,7 +62,7 @@ export class Media extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -135,7 +135,7 @@ export class Media extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -215,7 +215,7 @@ export class Media extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "post",
method: "POST",
path: path$,
headers: headers$,
query: query$,

View File

@@ -69,7 +69,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "post",
method: "POST",
path: path$,
headers: headers$,
query: query$,
@@ -148,7 +148,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -224,7 +224,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
body: body$,
@@ -298,7 +298,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,
@@ -372,7 +372,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "put",
method: "PUT",
path: path$,
headers: headers$,
body: body$,
@@ -457,7 +457,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -532,7 +532,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,
@@ -621,7 +621,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "put",
method: "PUT",
path: path$,
headers: headers$,
query: query$,
@@ -698,7 +698,7 @@ export class Playlists extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "post",
method: "POST",
path: path$,
headers: headers$,
query: query$,

View File

@@ -19,7 +19,7 @@ import { Sessions } from "./sessions";
import { Updater } from "./updater";
import { Video } from "./video";
export class SDK extends ClientSDK {
export class PlexAPI extends ClientSDK {
private readonly options$: SDKOptions;
constructor(options: SDKOptions = {}) {

View File

@@ -83,7 +83,7 @@ export class Search extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -169,7 +169,7 @@ export class Search extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -242,7 +242,7 @@ export class Search extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,

View File

@@ -66,7 +66,7 @@ export class Security extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -142,7 +142,7 @@ export class Security extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,

View File

@@ -47,7 +47,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -103,7 +103,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -156,7 +156,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -210,7 +210,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -266,7 +266,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -320,7 +320,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -404,7 +404,7 @@ export class Server extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -460,7 +460,7 @@ export class Server extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);

View File

@@ -45,7 +45,7 @@ export class Sessions extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -98,7 +98,7 @@ export class Sessions extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -151,7 +151,7 @@ export class Sessions extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -223,7 +223,7 @@ export class Sessions extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "delete",
method: "DELETE",
path: path$,
headers: headers$,
body: body$,

View File

@@ -45,7 +45,7 @@ export class Updater extends ClientSDK {
const securitySettings$ = this.resolveGlobalSecurity(security$);
const response = await this.fetch$(
{ security: securitySettings$, method: "get", path: path$, headers: headers$ },
{ security: securitySettings$, method: "GET", path: path$, headers: headers$ },
options
);
@@ -116,7 +116,7 @@ export class Updater extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "put",
method: "PUT",
path: path$,
headers: headers$,
query: query$,
@@ -196,7 +196,7 @@ export class Updater extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "put",
method: "PUT",
path: path$,
headers: headers$,
query: query$,

View File

@@ -116,7 +116,7 @@ export class Video extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,
@@ -210,7 +210,7 @@ export class Video extends ClientSDK {
const response = await this.fetch$(
{
security: securitySettings$,
method: "get",
method: "GET",
path: path$,
headers: headers$,
query: query$,

View File

@@ -5,4 +5,5 @@
export { Decimal } from "./decimal";
export { RFCDate } from "./rfcdate";
export { blobLikeSchema, isBlobLike } from "./blobs";
export type { Paginated, Paginator } from "./operations";
export type { Paginator, PageIterator } from "./operations";
export { createPageIterator } from "./operations";

View File

@@ -2,5 +2,24 @@
* Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
*/
export type Paginated<Result> = Result & { next: Paginator<Result> };
export type Paginator<Result> = () => Promise<Paginated<Result>> | null;
export type Paginator<Result> = () => Promise<PageIterator<Result>> | null;
export type PageIterator<Result> = Result & {
next: Paginator<Result>;
[Symbol.asyncIterator]: () => AsyncIterableIterator<Result>;
};
export function createPageIterator<Result>(
page: Result & { next: Paginator<Result> },
) {
return {
[Symbol.asyncIterator]: async function* paginator() {
yield page;
let p: typeof page | null = page;
for (p = await p.next(); p != null; p = await p.next()) {
yield p;
}
},
};
}