mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.133.1
This commit is contained in:
speakeasybot
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# This allows generated code to be indexed correctly
|
||||||
|
*.go linguist-generated=false
|
||||||
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# .gitignore
|
||||||
474
.speakeasy/gen.lock
Executable file
474
.speakeasy/gen.lock
Executable file
@@ -0,0 +1,474 @@
|
|||||||
|
lockVersion: 2.0.0
|
||||||
|
id: dfa99515-01c0-42eb-9be5-ee212fd03eb3
|
||||||
|
management:
|
||||||
|
docChecksum: 550154cf1b4d0c237436fb18c418b5db
|
||||||
|
docVersion: 0.0.3
|
||||||
|
speakeasyVersion: internal
|
||||||
|
generationVersion: 2.228.1
|
||||||
|
releaseVersion: 0.0.1
|
||||||
|
configChecksum: 17cc95530e519354b089a256cb0ca7f6
|
||||||
|
repoURL: https://github.com/LukeHagar/plexgo.git
|
||||||
|
repoSubDirectory: .
|
||||||
|
installationURL: https://github.com/LukeHagar/plexgo
|
||||||
|
published: true
|
||||||
|
features:
|
||||||
|
go:
|
||||||
|
constsAndDefaults: 0.1.2
|
||||||
|
core: 3.3.0
|
||||||
|
flattening: 2.81.1
|
||||||
|
globalSecurity: 2.82.3
|
||||||
|
globalServerURLs: 2.82.1
|
||||||
|
nameOverrides: 2.81.1
|
||||||
|
generatedFiles:
|
||||||
|
- server.go
|
||||||
|
- media.go
|
||||||
|
- activities.go
|
||||||
|
- butler.go
|
||||||
|
- hubs.go
|
||||||
|
- search.go
|
||||||
|
- library.go
|
||||||
|
- log.go
|
||||||
|
- playlists.go
|
||||||
|
- security.go
|
||||||
|
- sessions.go
|
||||||
|
- updater.go
|
||||||
|
- video.go
|
||||||
|
- plexapi.go
|
||||||
|
- go.mod
|
||||||
|
- go.sum
|
||||||
|
- tests/helpers.go
|
||||||
|
- models/sdkerrors/sdkerror.go
|
||||||
|
- types/bigint.go
|
||||||
|
- types/date.go
|
||||||
|
- types/datetime.go
|
||||||
|
- types/decimal.go
|
||||||
|
- types/pointers.go
|
||||||
|
- internal/utils/contenttype.go
|
||||||
|
- internal/utils/form.go
|
||||||
|
- internal/utils/headers.go
|
||||||
|
- internal/utils/json.go
|
||||||
|
- internal/utils/pathparams.go
|
||||||
|
- internal/utils/queryparams.go
|
||||||
|
- internal/utils/requestbody.go
|
||||||
|
- internal/utils/retries.go
|
||||||
|
- internal/utils/security.go
|
||||||
|
- internal/utils/utils.go
|
||||||
|
- /models/operations/getservercapabilities.go
|
||||||
|
- /models/operations/getserverpreferences.go
|
||||||
|
- /models/operations/getavailableclients.go
|
||||||
|
- /models/operations/getdevices.go
|
||||||
|
- /models/operations/getserveridentity.go
|
||||||
|
- /models/operations/getmyplexaccount.go
|
||||||
|
- /models/operations/getresizedphoto.go
|
||||||
|
- /models/operations/getserverlist.go
|
||||||
|
- /models/operations/markplayed.go
|
||||||
|
- /models/operations/markunplayed.go
|
||||||
|
- /models/operations/updateplayprogress.go
|
||||||
|
- /models/operations/getserveractivities.go
|
||||||
|
- /models/operations/cancelserveractivities.go
|
||||||
|
- /models/operations/getbutlertasks.go
|
||||||
|
- /models/operations/startalltasks.go
|
||||||
|
- /models/operations/stopalltasks.go
|
||||||
|
- /models/operations/starttask.go
|
||||||
|
- /models/operations/stoptask.go
|
||||||
|
- /models/operations/getglobalhubs.go
|
||||||
|
- /models/operations/getlibraryhubs.go
|
||||||
|
- /models/operations/performsearch.go
|
||||||
|
- /models/operations/performvoicesearch.go
|
||||||
|
- /models/operations/getsearchresults.go
|
||||||
|
- /models/operations/getfilehash.go
|
||||||
|
- /models/operations/getrecentlyadded.go
|
||||||
|
- /models/operations/getlibraries.go
|
||||||
|
- /models/operations/getlibrary.go
|
||||||
|
- /models/operations/deletelibrary.go
|
||||||
|
- /models/operations/getlibraryitems.go
|
||||||
|
- /models/operations/refreshlibrary.go
|
||||||
|
- /models/operations/getlatestlibraryitems.go
|
||||||
|
- /models/operations/getcommonlibraryitems.go
|
||||||
|
- /models/operations/getmetadata.go
|
||||||
|
- /models/operations/getmetadatachildren.go
|
||||||
|
- /models/operations/getondeck.go
|
||||||
|
- /models/operations/logline.go
|
||||||
|
- /models/operations/logmultiline.go
|
||||||
|
- /models/operations/enablepapertrail.go
|
||||||
|
- /models/operations/createplaylist.go
|
||||||
|
- /models/operations/getplaylists.go
|
||||||
|
- /models/operations/getplaylist.go
|
||||||
|
- /models/operations/deleteplaylist.go
|
||||||
|
- /models/operations/updateplaylist.go
|
||||||
|
- /models/operations/getplaylistcontents.go
|
||||||
|
- /models/operations/clearplaylistcontents.go
|
||||||
|
- /models/operations/addplaylistcontents.go
|
||||||
|
- /models/operations/uploadplaylist.go
|
||||||
|
- /models/operations/gettransienttoken.go
|
||||||
|
- /models/operations/getsourceconnectioninformation.go
|
||||||
|
- /models/operations/getsessions.go
|
||||||
|
- /models/operations/getsessionhistory.go
|
||||||
|
- /models/operations/gettranscodesessions.go
|
||||||
|
- /models/operations/stoptranscodesession.go
|
||||||
|
- /models/operations/getupdatestatus.go
|
||||||
|
- /models/operations/checkforupdates.go
|
||||||
|
- /models/operations/applyupdates.go
|
||||||
|
- /models/operations/startuniversaltranscode.go
|
||||||
|
- /models/operations/gettimeline.go
|
||||||
|
- /models/sdkerrors/getservercapabilities.go
|
||||||
|
- /models/sdkerrors/getserverpreferences.go
|
||||||
|
- /models/sdkerrors/getavailableclients.go
|
||||||
|
- /models/sdkerrors/getdevices.go
|
||||||
|
- /models/sdkerrors/getserveridentity.go
|
||||||
|
- /models/sdkerrors/getmyplexaccount.go
|
||||||
|
- /models/sdkerrors/getresizedphoto.go
|
||||||
|
- /models/sdkerrors/getserverlist.go
|
||||||
|
- /models/sdkerrors/markplayed.go
|
||||||
|
- /models/sdkerrors/markunplayed.go
|
||||||
|
- /models/sdkerrors/updateplayprogress.go
|
||||||
|
- /models/sdkerrors/getserveractivities.go
|
||||||
|
- /models/sdkerrors/cancelserveractivities.go
|
||||||
|
- /models/sdkerrors/getbutlertasks.go
|
||||||
|
- /models/sdkerrors/startalltasks.go
|
||||||
|
- /models/sdkerrors/stopalltasks.go
|
||||||
|
- /models/sdkerrors/starttask.go
|
||||||
|
- /models/sdkerrors/stoptask.go
|
||||||
|
- /models/sdkerrors/getglobalhubs.go
|
||||||
|
- /models/sdkerrors/getlibraryhubs.go
|
||||||
|
- /models/sdkerrors/performsearch.go
|
||||||
|
- /models/sdkerrors/performvoicesearch.go
|
||||||
|
- /models/sdkerrors/getsearchresults.go
|
||||||
|
- /models/sdkerrors/getfilehash.go
|
||||||
|
- /models/sdkerrors/getrecentlyadded.go
|
||||||
|
- /models/sdkerrors/getlibraries.go
|
||||||
|
- /models/sdkerrors/getlibrary.go
|
||||||
|
- /models/sdkerrors/deletelibrary.go
|
||||||
|
- /models/sdkerrors/getlibraryitems.go
|
||||||
|
- /models/sdkerrors/refreshlibrary.go
|
||||||
|
- /models/sdkerrors/getlatestlibraryitems.go
|
||||||
|
- /models/sdkerrors/getcommonlibraryitems.go
|
||||||
|
- /models/sdkerrors/getmetadata.go
|
||||||
|
- /models/sdkerrors/getmetadatachildren.go
|
||||||
|
- /models/sdkerrors/getondeck.go
|
||||||
|
- /models/sdkerrors/logline.go
|
||||||
|
- /models/sdkerrors/logmultiline.go
|
||||||
|
- /models/sdkerrors/enablepapertrail.go
|
||||||
|
- /models/sdkerrors/createplaylist.go
|
||||||
|
- /models/sdkerrors/getplaylists.go
|
||||||
|
- /models/sdkerrors/getplaylist.go
|
||||||
|
- /models/sdkerrors/deleteplaylist.go
|
||||||
|
- /models/sdkerrors/updateplaylist.go
|
||||||
|
- /models/sdkerrors/getplaylistcontents.go
|
||||||
|
- /models/sdkerrors/clearplaylistcontents.go
|
||||||
|
- /models/sdkerrors/addplaylistcontents.go
|
||||||
|
- /models/sdkerrors/uploadplaylist.go
|
||||||
|
- /models/sdkerrors/gettransienttoken.go
|
||||||
|
- /models/sdkerrors/getsourceconnectioninformation.go
|
||||||
|
- /models/sdkerrors/getsessions.go
|
||||||
|
- /models/sdkerrors/getsessionhistory.go
|
||||||
|
- /models/sdkerrors/gettranscodesessions.go
|
||||||
|
- /models/sdkerrors/stoptranscodesession.go
|
||||||
|
- /models/sdkerrors/getupdatestatus.go
|
||||||
|
- /models/sdkerrors/checkforupdates.go
|
||||||
|
- /models/sdkerrors/applyupdates.go
|
||||||
|
- /models/sdkerrors/startuniversaltranscode.go
|
||||||
|
- /models/sdkerrors/gettimeline.go
|
||||||
|
- /models/components/security.go
|
||||||
|
- 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/type.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/sdkerrors/errors.md
|
||||||
|
- docs/models/sdkerrors/getservercapabilitiesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getserverpreferenceserrors.md
|
||||||
|
- docs/models/sdkerrors/getserverpreferencesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getavailableclientserrors.md
|
||||||
|
- docs/models/sdkerrors/getavailableclientsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getdeviceserrors.md
|
||||||
|
- docs/models/sdkerrors/getdevicesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getserveridentityerrors.md
|
||||||
|
- docs/models/sdkerrors/getserveridentityresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getmyplexaccounterrors.md
|
||||||
|
- docs/models/sdkerrors/getmyplexaccountresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getresizedphotoerrors.md
|
||||||
|
- docs/models/sdkerrors/getresizedphotoresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getserverlisterrors.md
|
||||||
|
- docs/models/sdkerrors/getserverlistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/markplayederrors.md
|
||||||
|
- docs/models/sdkerrors/markplayedresponsebody.md
|
||||||
|
- docs/models/sdkerrors/markunplayederrors.md
|
||||||
|
- docs/models/sdkerrors/markunplayedresponsebody.md
|
||||||
|
- docs/models/sdkerrors/updateplayprogresserrors.md
|
||||||
|
- docs/models/sdkerrors/updateplayprogressresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getserveractivitieserrors.md
|
||||||
|
- docs/models/sdkerrors/getserveractivitiesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/cancelserveractivitieserrors.md
|
||||||
|
- docs/models/sdkerrors/cancelserveractivitiesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getbutlertaskserrors.md
|
||||||
|
- docs/models/sdkerrors/getbutlertasksresponsebody.md
|
||||||
|
- docs/models/sdkerrors/startalltaskserrors.md
|
||||||
|
- docs/models/sdkerrors/startalltasksresponsebody.md
|
||||||
|
- docs/models/sdkerrors/stopalltaskserrors.md
|
||||||
|
- docs/models/sdkerrors/stopalltasksresponsebody.md
|
||||||
|
- docs/models/sdkerrors/starttaskerrors.md
|
||||||
|
- docs/models/sdkerrors/starttaskresponsebody.md
|
||||||
|
- docs/models/sdkerrors/stoptaskerrors.md
|
||||||
|
- docs/models/sdkerrors/stoptaskresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getglobalhubserrors.md
|
||||||
|
- docs/models/sdkerrors/getglobalhubsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getlibraryhubserrors.md
|
||||||
|
- docs/models/sdkerrors/getlibraryhubsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/performsearcherrors.md
|
||||||
|
- docs/models/sdkerrors/performsearchresponsebody.md
|
||||||
|
- docs/models/sdkerrors/performvoicesearcherrors.md
|
||||||
|
- docs/models/sdkerrors/performvoicesearchresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getsearchresultserrors.md
|
||||||
|
- docs/models/sdkerrors/getsearchresultsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getfilehasherrors.md
|
||||||
|
- docs/models/sdkerrors/getfilehashresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getrecentlyaddederrors.md
|
||||||
|
- docs/models/sdkerrors/getrecentlyaddedresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getlibrarieserrors.md
|
||||||
|
- docs/models/sdkerrors/getlibrariesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getlibraryerrors.md
|
||||||
|
- docs/models/sdkerrors/getlibraryresponsebody.md
|
||||||
|
- docs/models/sdkerrors/deletelibraryerrors.md
|
||||||
|
- docs/models/sdkerrors/deletelibraryresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getlibraryitemserrors.md
|
||||||
|
- docs/models/sdkerrors/getlibraryitemsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/refreshlibraryerrors.md
|
||||||
|
- docs/models/sdkerrors/refreshlibraryresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getlatestlibraryitemserrors.md
|
||||||
|
- docs/models/sdkerrors/getlatestlibraryitemsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getcommonlibraryitemserrors.md
|
||||||
|
- docs/models/sdkerrors/getcommonlibraryitemsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getmetadataerrors.md
|
||||||
|
- docs/models/sdkerrors/getmetadataresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getmetadatachildrenerrors.md
|
||||||
|
- docs/models/sdkerrors/getmetadatachildrenresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getondeckerrors.md
|
||||||
|
- docs/models/sdkerrors/getondeckresponsebody.md
|
||||||
|
- docs/models/sdkerrors/loglineerrors.md
|
||||||
|
- docs/models/sdkerrors/loglineresponsebody.md
|
||||||
|
- docs/models/sdkerrors/logmultilineerrors.md
|
||||||
|
- docs/models/sdkerrors/logmultilineresponsebody.md
|
||||||
|
- docs/models/sdkerrors/enablepapertrailerrors.md
|
||||||
|
- docs/models/sdkerrors/enablepapertrailresponsebody.md
|
||||||
|
- docs/models/sdkerrors/createplaylisterrors.md
|
||||||
|
- docs/models/sdkerrors/createplaylistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getplaylistserrors.md
|
||||||
|
- docs/models/sdkerrors/getplaylistsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getplaylisterrors.md
|
||||||
|
- docs/models/sdkerrors/getplaylistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/deleteplaylisterrors.md
|
||||||
|
- docs/models/sdkerrors/deleteplaylistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/updateplaylisterrors.md
|
||||||
|
- docs/models/sdkerrors/updateplaylistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getplaylistcontentserrors.md
|
||||||
|
- docs/models/sdkerrors/getplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/clearplaylistcontentserrors.md
|
||||||
|
- docs/models/sdkerrors/clearplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/addplaylistcontentserrors.md
|
||||||
|
- docs/models/sdkerrors/addplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/uploadplaylisterrors.md
|
||||||
|
- docs/models/sdkerrors/uploadplaylistresponsebody.md
|
||||||
|
- docs/models/sdkerrors/gettransienttokenerrors.md
|
||||||
|
- docs/models/sdkerrors/gettransienttokenresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getsourceconnectioninformationerrors.md
|
||||||
|
- docs/models/sdkerrors/getsourceconnectioninformationresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getsessionserrors.md
|
||||||
|
- docs/models/sdkerrors/getsessionsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getsessionhistoryerrors.md
|
||||||
|
- docs/models/sdkerrors/getsessionhistoryresponsebody.md
|
||||||
|
- docs/models/sdkerrors/gettranscodesessionserrors.md
|
||||||
|
- docs/models/sdkerrors/gettranscodesessionsresponsebody.md
|
||||||
|
- docs/models/sdkerrors/stoptranscodesessionerrors.md
|
||||||
|
- docs/models/sdkerrors/stoptranscodesessionresponsebody.md
|
||||||
|
- docs/models/sdkerrors/getupdatestatuserrors.md
|
||||||
|
- docs/models/sdkerrors/getupdatestatusresponsebody.md
|
||||||
|
- docs/models/sdkerrors/checkforupdateserrors.md
|
||||||
|
- docs/models/sdkerrors/checkforupdatesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/applyupdateserrors.md
|
||||||
|
- docs/models/sdkerrors/applyupdatesresponsebody.md
|
||||||
|
- docs/models/sdkerrors/startuniversaltranscodeerrors.md
|
||||||
|
- docs/models/sdkerrors/startuniversaltranscoderesponsebody.md
|
||||||
|
- docs/models/sdkerrors/gettimelineerrors.md
|
||||||
|
- docs/models/sdkerrors/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
|
||||||
385
README.md
Normal file
385
README.md
Normal file
@@ -0,0 +1,385 @@
|
|||||||
|
# github.com/LukeHagar/plexgo
|
||||||
|
|
||||||
|
<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>
|
||||||
|
<a href="https://opensource.org/licenses/MIT">
|
||||||
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
||||||
|
</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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get github.com/LukeHagar/plexgo
|
||||||
|
```
|
||||||
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
## SDK Example Usage
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/components"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
|
|
||||||
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
|
## Available Resources and Operations
|
||||||
|
|
||||||
|
### [Server](docs/sdks/server/README.md)
|
||||||
|
|
||||||
|
* [GetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Server Capabilities
|
||||||
|
* [GetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
|
* [GetAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
|
* [GetDevices](docs/sdks/server/README.md#getdevices) - Get Devices
|
||||||
|
* [GetServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
|
||||||
|
* [GetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
|
||||||
|
* [GetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||||
|
* [GetServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||||
|
|
||||||
|
### [Media](docs/sdks/media/README.md)
|
||||||
|
|
||||||
|
* [MarkPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||||
|
* [MarkUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
|
* [UpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
||||||
|
|
||||||
|
### [Activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
|
* [GetServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
|
||||||
|
* [CancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||||
|
|
||||||
|
### [Butler](docs/sdks/butler/README.md)
|
||||||
|
|
||||||
|
* [GetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
|
||||||
|
* [StartAllTasks](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
|
||||||
|
* [StopAllTasks](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
|
||||||
|
* [StartTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
||||||
|
* [StopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
|
||||||
|
|
||||||
|
### [Hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
|
* [GetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
|
* [GetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
|
### [Search](docs/sdks/search/README.md)
|
||||||
|
|
||||||
|
* [PerformSearch](docs/sdks/search/README.md#performsearch) - Perform a search
|
||||||
|
* [PerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
||||||
|
* [GetSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
||||||
|
|
||||||
|
### [Library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
|
* [GetFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
|
* [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
|
||||||
|
* [DeleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
|
* [GetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
|
* [RefreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
||||||
|
* [GetLatestLibraryItems](docs/sdks/library/README.md#getlatestlibraryitems) - Get Latest Library Items
|
||||||
|
* [GetCommonLibraryItems](docs/sdks/library/README.md#getcommonlibraryitems) - Get Common Library Items
|
||||||
|
* [GetMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
||||||
|
* [GetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
|
* [GetOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
|
|
||||||
|
### [Log](docs/sdks/log/README.md)
|
||||||
|
|
||||||
|
* [LogLine](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||||
|
* [LogMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||||
|
* [EnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [Playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
|
* [CreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
|
* [GetPlaylists](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
|
||||||
|
* [GetPlaylist](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
|
||||||
|
* [DeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
|
||||||
|
* [UpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
|
||||||
|
* [GetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
|
||||||
|
* [ClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
|
||||||
|
* [AddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
||||||
|
* [UploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
|
||||||
|
|
||||||
|
### [Security](docs/sdks/security/README.md)
|
||||||
|
|
||||||
|
* [GetTransientToken](docs/sdks/security/README.md#gettransienttoken) - Get a Transient Token.
|
||||||
|
* [GetSourceConnectionInformation](docs/sdks/security/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
||||||
|
|
||||||
|
### [Sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
|
* [GetSessions](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
|
||||||
|
* [GetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
|
||||||
|
* [GetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
|
||||||
|
* [StopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
|
||||||
|
|
||||||
|
### [Updater](docs/sdks/updater/README.md)
|
||||||
|
|
||||||
|
* [GetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
|
||||||
|
* [CheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
|
* [ApplyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [Video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [StartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
* [GetTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Error Handling [errors] -->
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
|
||||||
|
|
||||||
|
| Error Object | Status Code | Content Type |
|
||||||
|
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||||
|
| sdkerrors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
||||||
|
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/components"
|
||||||
|
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
|
||||||
|
var e *sdkerrors.GetServerCapabilitiesResponseBody
|
||||||
|
if errors.As(err, &e) {
|
||||||
|
// handle error
|
||||||
|
log.Fatal(e.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
var e *sdkerrors.SDKError
|
||||||
|
if errors.As(err, &e) {
|
||||||
|
// handle error
|
||||||
|
log.Fatal(e.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
|
<!-- Start Server Selection [server] -->
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
### Select Server by Index
|
||||||
|
|
||||||
|
You can override the default server globally using the `WithServerIndex` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||||
|
|
||||||
|
| # | Server | Variables |
|
||||||
|
| - | ------ | --------- |
|
||||||
|
| 0 | `http://10.10.10.47:32400` | None |
|
||||||
|
| 1 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/components"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithServerIndex(1),
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Variables
|
||||||
|
|
||||||
|
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
|
||||||
|
* `WithProtocol plexgo.ServerProtocol`
|
||||||
|
* `WithIP string`
|
||||||
|
* `WithPort string`
|
||||||
|
|
||||||
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
|
The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/components"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithServerURL("http://10.10.10.47:32400"),
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
|
<!-- Start Custom HTTP Client [http-client] -->
|
||||||
|
## Custom HTTP Client
|
||||||
|
|
||||||
|
The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
|
||||||
|
|
||||||
|
```go
|
||||||
|
type HTTPClient interface {
|
||||||
|
Do(req *http.Request) (*http.Response, error)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The built-in `net/http` client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
"github.com/myorg/your-go-sdk"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
httpClient = &http.Client{Timeout: 30 * time.Second}
|
||||||
|
sdkClient = sdk.New(sdk.WithClient(httpClient))
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
|
||||||
|
<!-- End Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
|
<!-- Start Authentication [security] -->
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
### Per-Client Security Schemes
|
||||||
|
|
||||||
|
This SDK supports the following security scheme globally:
|
||||||
|
|
||||||
|
| Name | Type | Scheme |
|
||||||
|
| ------------- | ------------- | ------------- |
|
||||||
|
| `AccessToken` | apiKey | API key |
|
||||||
|
|
||||||
|
You can configure it using the `WithSecurity` option when initializing the SDK client instance. For example:
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Authentication [security] -->
|
||||||
|
|
||||||
|
<!-- Start Special Types [types] -->
|
||||||
|
## Special Types
|
||||||
|
|
||||||
|
|
||||||
|
<!-- End Special Types [types] -->
|
||||||
|
|
||||||
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## Maturity
|
||||||
|
|
||||||
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||||
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||||
|
looking for the latest version.
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
|
While we value open-source contributions to this SDK, this library is generated programmatically.
|
||||||
|
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
|
||||||
|
|
||||||
|
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
|
||||||
11
RELEASES.md
Normal file
11
RELEASES.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
## 2024-01-05 19:39:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.0.1] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.0.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.0.1 - .
|
||||||
29
USAGE.md
Normal file
29
USAGE.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/components"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
res, err := s.Server.GetServerCapabilities(ctx)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
176
activities.go
Normal file
176
activities.go
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
// Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||||
|
|
||||||
|
package plexgo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/LukeHagar/plexgo/internal/utils"
|
||||||
|
"github.com/LukeHagar/plexgo/models/operations"
|
||||||
|
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
||||||
|
// Activities are associated with HTTP replies via a special `X-Plex-Activity` header which contains the UUID of the activity.
|
||||||
|
// Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details:
|
||||||
|
// - They can contain a `progress` (from 0 to 100) marking the percent completion of the activity.
|
||||||
|
// - They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||||
|
// - They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||||
|
// - The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||||
|
type Activities struct {
|
||||||
|
sdkConfiguration sdkConfiguration
|
||||||
|
}
|
||||||
|
|
||||||
|
func newActivities(sdkConfig sdkConfiguration) *Activities {
|
||||||
|
return &Activities{
|
||||||
|
sdkConfiguration: sdkConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetServerActivities - Get Server Activities
|
||||||
|
// Get Server Activities
|
||||||
|
func (s *Activities) GetServerActivities(ctx context.Context) (*operations.GetServerActivitiesResponse, error) {
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url := strings.TrimSuffix(baseURL, "/") + "/activities"
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.GetServerActivitiesResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out operations.GetServerActivitiesResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
res.Object = &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.GetServerActivitiesResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CancelServerActivities - Cancel Server Activities
|
||||||
|
// Cancel Server Activities
|
||||||
|
func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID string) (*operations.CancelServerActivitiesResponse, error) {
|
||||||
|
request := operations.CancelServerActivitiesRequest{
|
||||||
|
ActivityUUID: activityUUID,
|
||||||
|
}
|
||||||
|
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url, err := utils.GenerateURL(ctx, baseURL, "/activities/{activityUUID}", request, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error generating URL: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "DELETE", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.CancelServerActivitiesResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.CancelServerActivitiesResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
378
butler.go
Normal file
378
butler.go
Normal file
@@ -0,0 +1,378 @@
|
|||||||
|
// Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||||
|
|
||||||
|
package plexgo
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/LukeHagar/plexgo/internal/utils"
|
||||||
|
"github.com/LukeHagar/plexgo/models/operations"
|
||||||
|
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Butler is the task manager of the Plex Media Server Ecosystem.
|
||||||
|
type Butler struct {
|
||||||
|
sdkConfiguration sdkConfiguration
|
||||||
|
}
|
||||||
|
|
||||||
|
func newButler(sdkConfig sdkConfiguration) *Butler {
|
||||||
|
return &Butler{
|
||||||
|
sdkConfiguration: sdkConfig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetButlerTasks - Get Butler tasks
|
||||||
|
// Returns a list of butler tasks
|
||||||
|
func (s *Butler) GetButlerTasks(ctx context.Context) (*operations.GetButlerTasksResponse, error) {
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url := strings.TrimSuffix(baseURL, "/") + "/butler"
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.GetButlerTasksResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out operations.GetButlerTasksResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
res.Object = &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.GetButlerTasksResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StartAllTasks - Start all Butler tasks
|
||||||
|
// This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
|
// 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
|
// 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
|
// 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
|
// 4. If we are outside the configured window, the task will start immediately.
|
||||||
|
func (s *Butler) StartAllTasks(ctx context.Context) (*operations.StartAllTasksResponse, error) {
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url := strings.TrimSuffix(baseURL, "/") + "/butler"
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "POST", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.StartAllTasksResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.StartAllTasksResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopAllTasks - Stop all Butler tasks
|
||||||
|
// This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||||
|
func (s *Butler) StopAllTasks(ctx context.Context) (*operations.StopAllTasksResponse, error) {
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url := strings.TrimSuffix(baseURL, "/") + "/butler"
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "DELETE", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.StopAllTasksResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.StopAllTasksResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StartTask - Start a single Butler task
|
||||||
|
// This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
||||||
|
// 1. Any tasks not scheduled to run on the current day will be skipped.
|
||||||
|
// 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
||||||
|
// 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
||||||
|
// 4. If we are outside the configured window, the task will start immediately.
|
||||||
|
func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName) (*operations.StartTaskResponse, error) {
|
||||||
|
request := operations.StartTaskRequest{
|
||||||
|
TaskName: taskName,
|
||||||
|
}
|
||||||
|
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url, err := utils.GenerateURL(ctx, baseURL, "/butler/{taskName}", request, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error generating URL: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "POST", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.StartTaskResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode == 202:
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.StartTaskResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopTask - Stop a single Butler task
|
||||||
|
// This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
||||||
|
func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTaskName) (*operations.StopTaskResponse, error) {
|
||||||
|
request := operations.StopTaskRequest{
|
||||||
|
TaskName: taskName,
|
||||||
|
}
|
||||||
|
|
||||||
|
baseURL := utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
url, err := utils.GenerateURL(ctx, baseURL, "/butler/{taskName}", request, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error generating URL: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "DELETE", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("user-agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
client := s.sdkConfiguration.SecurityClient
|
||||||
|
|
||||||
|
httpRes, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: %w", err)
|
||||||
|
}
|
||||||
|
if httpRes == nil {
|
||||||
|
return nil, fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := httpRes.Header.Get("Content-Type")
|
||||||
|
|
||||||
|
res := &operations.StopTaskResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: contentType,
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rawBody, err := io.ReadAll(httpRes.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error reading response body: %w", err)
|
||||||
|
}
|
||||||
|
httpRes.Body.Close()
|
||||||
|
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode == 404:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(contentType, `application/json`):
|
||||||
|
var out sdkerrors.StopTaskResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", contentType), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
8
docs/models/components/security.md
Normal file
8
docs/models/components/security.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `AccessToken` | *string* | :heavy_check_mark: | N/A |
|
||||||
15
docs/models/operations/activity.md
Normal file
15
docs/models/operations/activity.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Activity
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
||||||
|
| `UUID` | **string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Cancellable` | **bool* | :heavy_minus_sign: | N/A |
|
||||||
|
| `UserID` | **float64* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Subtitle` | **string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Progress` | **float64* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Context` | [*operations.Context](../../models/operations/context.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/addplaylistcontentsrequest.md
Normal file
10
docs/models/operations/addplaylistcontentsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist | |
|
||||||
|
| `URI` | *string* | :heavy_check_mark: | the content URI for the playlist | library://.. |
|
||||||
|
| `PlayQueueID` | *float64* | :heavy_check_mark: | the play queue to add to a playlist | 123 |
|
||||||
10
docs/models/operations/addplaylistcontentsresponse.md
Normal file
10
docs/models/operations/addplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
9
docs/models/operations/applyupdatesrequest.md
Normal file
9
docs/models/operations/applyupdatesrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ApplyUpdatesRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Tonight` | [*operations.Tonight](../../models/operations/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 |
|
||||||
|
| `Skip` | [*operations.Skip](../../models/operations/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`. |
|
||||||
10
docs/models/operations/applyupdatesresponse.md
Normal file
10
docs/models/operations/applyupdatesresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
13
docs/models/operations/butlertask.md
Normal file
13
docs/models/operations/butlertask.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# ButlerTask
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
|
| `Name` | **string* | :heavy_minus_sign: | N/A | BackupDatabase |
|
||||||
|
| `Interval` | **float64* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `ScheduleRandomized` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Enabled` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Backup Database |
|
||||||
|
| `Description` | **string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |
|
||||||
8
docs/models/operations/butlertasks.md
Normal file
8
docs/models/operations/butlertasks.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# ButlerTasks
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `ButlerTask` | [][operations.ButlerTask](../../models/operations/butlertask.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/cancelserveractivitiesrequest.md
Normal file
8
docs/models/operations/cancelserveractivitiesrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# CancelServerActivitiesRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `ActivityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
||||||
10
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
10
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/checkforupdatesrequest.md
Normal file
8
docs/models/operations/checkforupdatesrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# CheckForUpdatesRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
|
| `Download` | [*operations.Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
|
||||||
10
docs/models/operations/checkforupdatesresponse.md
Normal file
10
docs/models/operations/checkforupdatesresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/clearplaylistcontentsrequest.md
Normal file
8
docs/models/operations/clearplaylistcontentsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# ClearPlaylistContentsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist |
|
||||||
10
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
10
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/context.md
Normal file
8
docs/models/operations/context.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Context
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `LibrarySectionID` | **string* | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/country.md
Normal file
8
docs/models/operations/country.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Country
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
12
docs/models/operations/createplaylistrequest.md
Normal file
12
docs/models/operations/createplaylistrequest.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# CreatePlaylistRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
|
||||||
|
| `Type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | type of playlist to create |
|
||||||
|
| `Smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||||
|
| `URI` | **string* | :heavy_minus_sign: | the content URI for the playlist |
|
||||||
|
| `PlayQueueID` | **float64* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||||
10
docs/models/operations/createplaylistresponse.md
Normal file
10
docs/models/operations/createplaylistresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/deletelibraryrequest.md
Normal file
8
docs/models/operations/deletelibraryrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# DeleteLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||||
10
docs/models/operations/deletelibraryresponse.md
Normal file
10
docs/models/operations/deletelibraryresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/deleteplaylistrequest.md
Normal file
8
docs/models/operations/deleteplaylistrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# DeletePlaylistRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist |
|
||||||
10
docs/models/operations/deleteplaylistresponse.md
Normal file
10
docs/models/operations/deleteplaylistresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
12
docs/models/operations/device.md
Normal file
12
docs/models/operations/device.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Device
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Name` | **string* | :heavy_minus_sign: | N/A | iPhone |
|
||||||
|
| `Platform` | **string* | :heavy_minus_sign: | N/A | iOS |
|
||||||
|
| `ClientIdentifier` | **string* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `CreatedAt` | **float64* | :heavy_minus_sign: | N/A | 1654131230 |
|
||||||
8
docs/models/operations/director.md
Normal file
8
docs/models/operations/director.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Director
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||||
10
docs/models/operations/directory.md
Normal file
10
docs/models/operations/directory.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Directory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Count` | **float64* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/download.md
Normal file
11
docs/models/operations/download.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Download
|
||||||
|
|
||||||
|
Indicate that you want to start download any updates found.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `DownloadZero` | 0 |
|
||||||
|
| `DownloadOne` | 1 |
|
||||||
10
docs/models/operations/enablepapertrailresponse.md
Normal file
10
docs/models/operations/enablepapertrailresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
13
docs/models/operations/force.md
Normal file
13
docs/models/operations/force.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `ForceZero` | 0 |
|
||||||
|
| `ForceOne` | 1 |
|
||||||
8
docs/models/operations/genre.md
Normal file
8
docs/models/operations/genre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Genre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Comedy |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAvailableClientsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Server` | [][operations.Server](../../models/operations/server.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getavailableclientsresponse.md
Normal file
11
docs/models/operations/getavailableclientsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAvailableClientsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `ResponseBodies` | [][operations.ResponseBody](../../models/operations/responsebody.md) | :heavy_minus_sign: | Available Clients |
|
||||||
11
docs/models/operations/getbutlertasksresponse.md
Normal file
11
docs/models/operations/getbutlertasksresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetButlerTasksResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetButlerTasksResponseBody](../../models/operations/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |
|
||||||
10
docs/models/operations/getbutlertasksresponsebody.md
Normal file
10
docs/models/operations/getbutlertasksresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetButlerTasksResponseBody
|
||||||
|
|
||||||
|
All butler tasks
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
|
| `ButlerTasks` | [*operations.ButlerTasks](../../models/operations/butlertasks.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getcommonlibraryitemsrequest.md
Normal file
10
docs/models/operations/getcommonlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCommonLibraryItemsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query |
|
||||||
|
| `Type` | *float64* | :heavy_check_mark: | item type |
|
||||||
|
| `Filter` | **string* | :heavy_minus_sign: | the filter parameter |
|
||||||
10
docs/models/operations/getcommonlibraryitemsresponse.md
Normal file
10
docs/models/operations/getcommonlibraryitemsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCommonLibraryItemsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/getdevicesmediacontainer.md
Normal file
10
docs/models/operations/getdevicesmediacontainer.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetDevicesMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 151 |
|
||||||
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
|
||||||
|
| `Device` | [][operations.Device](../../models/operations/device.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getdevicesresponse.md
Normal file
11
docs/models/operations/getdevicesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetDevicesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetDevicesResponseBody](../../models/operations/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |
|
||||||
10
docs/models/operations/getdevicesresponsebody.md
Normal file
10
docs/models/operations/getdevicesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetDevicesResponseBody
|
||||||
|
|
||||||
|
Devices
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetDevicesMediaContainer](../../models/operations/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/getfilehashrequest.md
Normal file
9
docs/models/operations/getfilehashrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetFileHashRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
|
| `URL` | *string* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
|
||||||
|
| `Type` | **float64* | :heavy_minus_sign: | Item type | |
|
||||||
10
docs/models/operations/getfilehashresponse.md
Normal file
10
docs/models/operations/getfilehashresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetFileHashResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
9
docs/models/operations/getglobalhubsrequest.md
Normal file
9
docs/models/operations/getglobalhubsrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetGlobalHubsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Count` | **float64* | :heavy_minus_sign: | The number of items to return with each hub. |
|
||||||
|
| `OnlyTransient` | [*operations.OnlyTransient](../../models/operations/onlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
|
||||||
10
docs/models/operations/getglobalhubsresponse.md
Normal file
10
docs/models/operations/getglobalhubsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGlobalHubsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/getlatestlibraryitemsrequest.md
Normal file
10
docs/models/operations/getlatestlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLatestLibraryItemsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query |
|
||||||
|
| `Type` | *float64* | :heavy_check_mark: | item type |
|
||||||
|
| `Filter` | **string* | :heavy_minus_sign: | the filter parameter |
|
||||||
10
docs/models/operations/getlatestlibraryitemsresponse.md
Normal file
10
docs/models/operations/getlatestlibraryitemsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLatestLibraryItemsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/getlibrariesresponse.md
Normal file
10
docs/models/operations/getlibrariesresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrariesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/getlibraryhubsrequest.md
Normal file
10
docs/models/operations/getlibraryhubsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryHubsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query |
|
||||||
|
| `Count` | **float64* | :heavy_minus_sign: | The number of items to return with each hub. |
|
||||||
|
| `OnlyTransient` | [*operations.QueryParamOnlyTransient](../../models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
|
||||||
10
docs/models/operations/getlibraryhubsresponse.md
Normal file
10
docs/models/operations/getlibraryhubsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryHubsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/operations/getlibraryitemsrequest.md
Normal file
10
docs/models/operations/getlibraryitemsrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query |
|
||||||
|
| `Type` | **float64* | :heavy_minus_sign: | item type |
|
||||||
|
| `Filter` | **string* | :heavy_minus_sign: | the filter parameter |
|
||||||
10
docs/models/operations/getlibraryitemsresponse.md
Normal file
10
docs/models/operations/getlibraryitemsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
9
docs/models/operations/getlibraryrequest.md
Normal file
9
docs/models/operations/getlibraryrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||||
|
| `IncludeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
10
docs/models/operations/getlibraryresponse.md
Normal file
10
docs/models/operations/getlibraryresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/getmetadatachildrenrequest.md
Normal file
8
docs/models/operations/getmetadatachildrenrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMetadataChildrenRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||||
|
| `RatingKey` | *float64* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||||
10
docs/models/operations/getmetadatachildrenresponse.md
Normal file
10
docs/models/operations/getmetadatachildrenresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataChildrenResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/getmetadatarequest.md
Normal file
8
docs/models/operations/getmetadatarequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMetadataRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||||
|
| `RatingKey` | *float64* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||||
10
docs/models/operations/getmetadataresponse.md
Normal file
10
docs/models/operations/getmetadataresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMetadataResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/operations/getmyplexaccountresponse.md
Normal file
11
docs/models/operations/getmyplexaccountresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMyPlexAccountResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetMyPlexAccountResponseBody](../../models/operations/getmyplexaccountresponsebody.md) | :heavy_minus_sign: | MyPlex Account |
|
||||||
10
docs/models/operations/getmyplexaccountresponsebody.md
Normal file
10
docs/models/operations/getmyplexaccountresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMyPlexAccountResponseBody
|
||||||
|
|
||||||
|
MyPlex Account
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `MyPlex` | [*operations.MyPlex](../../models/operations/myplex.md) | :heavy_minus_sign: | N/A |
|
||||||
22
docs/models/operations/getondeckmedia.md
Normal file
22
docs/models/operations/getondeckmedia.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetOnDeckMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 80994 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||||
|
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 1046 |
|
||||||
|
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||||
|
| `Height` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.78 |
|
||||||
|
| `AudioChannels` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||||
|
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | PAL |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main |
|
||||||
|
| `Part` | [][operations.GetOnDeckPart](../../models/operations/getondeckpart.md) | :heavy_minus_sign: | N/A | |
|
||||||
14
docs/models/operations/getondeckmediacontainer.md
Normal file
14
docs/models/operations/getondeckmediacontainer.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetOnDeckMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 16 |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||||
|
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Metadata` | [][operations.GetOnDeckMetadata](../../models/operations/getondeckmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||||
43
docs/models/operations/getondeckmetadata.md
Normal file
43
docs/models/operations/getondeckmetadata.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# GetOnDeckMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `LibrarySectionID` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||||
|
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
||||||
|
| `RatingKey` | **float64* | :heavy_minus_sign: | N/A | 49564 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
|
||||||
|
| `ParentRatingKey` | **float64* | :heavy_minus_sign: | N/A | 49557 |
|
||||||
|
| `GrandparentRatingKey` | **float64* | :heavy_minus_sign: | N/A | 49556 |
|
||||||
|
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
|
||||||
|
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
|
||||||
|
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A | episode |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Circus |
|
||||||
|
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
|
||||||
|
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
|
||||||
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/2 |
|
||||||
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Bluey (2018) |
|
||||||
|
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||||
|
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | TV-Y |
|
||||||
|
| `Summary` | **string* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
|
||||||
|
| `Index` | **float64* | :heavy_minus_sign: | N/A | 33 |
|
||||||
|
| `ParentIndex` | **float64* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `LastViewedAt` | **float64* | :heavy_minus_sign: | N/A | 1681908352 |
|
||||||
|
| `Year` | **float64* | :heavy_minus_sign: | N/A | 2018 |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
|
||||||
|
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||||
|
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
|
||||||
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
|
||||||
|
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||||
|
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||||
|
| `OriginallyAvailableAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
|
||||||
|
| `AddedAt` | **float64* | :heavy_minus_sign: | N/A | 1654258196 |
|
||||||
|
| `UpdatedAt` | **float64* | :heavy_minus_sign: | N/A | 1654258204 |
|
||||||
|
| `Media` | [][operations.GetOnDeckMedia](../../models/operations/getondeckmedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_minus_sign: | N/A | |
|
||||||
16
docs/models/operations/getondeckpart.md
Normal file
16
docs/models/operations/getondeckpart.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetOnDeckPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 80994 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 420080 |
|
||||||
|
| `File` | **string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 55148931 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main |
|
||||||
|
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getondeckresponse.md
Normal file
11
docs/models/operations/getondeckresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetOnDeckResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetOnDeckResponseBody](../../models/operations/getondeckresponsebody.md) | :heavy_minus_sign: | The on Deck content |
|
||||||
10
docs/models/operations/getondeckresponsebody.md
Normal file
10
docs/models/operations/getondeckresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetOnDeckResponseBody
|
||||||
|
|
||||||
|
The on Deck content
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetOnDeckMediaContainer](../../models/operations/getondeckmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/getplaylistcontentsrequest.md
Normal file
9
docs/models/operations/getplaylistcontentsrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetPlaylistContentsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||||
|
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist |
|
||||||
|
| `Type` | *float64* | :heavy_check_mark: | the metadata type of the item to return |
|
||||||
10
docs/models/operations/getplaylistcontentsresponse.md
Normal file
10
docs/models/operations/getplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetPlaylistContentsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/getplaylistrequest.md
Normal file
8
docs/models/operations/getplaylistrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetPlaylistRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist |
|
||||||
10
docs/models/operations/getplaylistresponse.md
Normal file
10
docs/models/operations/getplaylistresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetPlaylistResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
9
docs/models/operations/getplaylistsrequest.md
Normal file
9
docs/models/operations/getplaylistsrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetPlaylistsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||||
|
| `PlaylistType` | [*operations.PlaylistType](../../models/operations/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
|
||||||
|
| `Smart` | [*operations.QueryParamSmart](../../models/operations/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
|
||||||
10
docs/models/operations/getplaylistsresponse.md
Normal file
10
docs/models/operations/getplaylistsresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetPlaylistsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
14
docs/models/operations/getrecentlyaddedmediacontainer.md
Normal file
14
docs/models/operations/getrecentlyaddedmediacontainer.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetRecentlyAddedMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||||
|
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Metadata` | [][operations.Metadata](../../models/operations/metadata.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getrecentlyaddedresponse.md
Normal file
11
docs/models/operations/getrecentlyaddedresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetRecentlyAddedResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetRecentlyAddedResponseBody](../../models/operations/getrecentlyaddedresponsebody.md) | :heavy_minus_sign: | The recently added content |
|
||||||
10
docs/models/operations/getrecentlyaddedresponsebody.md
Normal file
10
docs/models/operations/getrecentlyaddedresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetRecentlyAddedResponseBody
|
||||||
|
|
||||||
|
The recently added content
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetRecentlyAddedMediaContainer](../../models/operations/getrecentlyaddedmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
14
docs/models/operations/getresizedphotorequest.md
Normal file
14
docs/models/operations/getresizedphotorequest.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# GetResizedPhotoRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Width` | *float64* | :heavy_check_mark: | The width for the resized photo | 110 |
|
||||||
|
| `Height` | *float64* | :heavy_check_mark: | The height for the resized photo | 165 |
|
||||||
|
| `Opacity` | *int64* | :heavy_check_mark: | The opacity for the resized photo | |
|
||||||
|
| `Blur` | *float64* | :heavy_check_mark: | The width for the resized photo | 0 |
|
||||||
|
| `MinSize` | [operations.MinSize](../../models/operations/minsize.md) | :heavy_check_mark: | images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against. | |
|
||||||
|
| `Upscale` | [operations.Upscale](../../models/operations/upscale.md) | :heavy_check_mark: | allow images to be resized beyond native dimensions. | |
|
||||||
|
| `URL` | *string* | :heavy_check_mark: | path to image within Plex | /library/metadata/49564/thumb/1654258204 |
|
||||||
10
docs/models/operations/getresizedphotoresponse.md
Normal file
10
docs/models/operations/getresizedphotoresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetResizedPhotoResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
8
docs/models/operations/getsearchresultscountry.md
Normal file
8
docs/models/operations/getsearchresultscountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
8
docs/models/operations/getsearchresultsdirector.md
Normal file
8
docs/models/operations/getsearchresultsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Brian De Palma |
|
||||||
8
docs/models/operations/getsearchresultsgenre.md
Normal file
8
docs/models/operations/getsearchresultsgenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Action |
|
||||||
22
docs/models/operations/getsearchresultsmedia.md
Normal file
22
docs/models/operations/getsearchresultsmedia.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetSearchResultsMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 26610 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 6612628 |
|
||||||
|
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 4751 |
|
||||||
|
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1916 |
|
||||||
|
| `Height` | **float64* | :heavy_minus_sign: | N/A | 796 |
|
||||||
|
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 2.35 |
|
||||||
|
| `AudioChannels` | **float64* | :heavy_minus_sign: | N/A | 6 |
|
||||||
|
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | aac |
|
||||||
|
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||||
|
| `VideoResolution` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
|
| `Part` | [][operations.GetSearchResultsPart](../../models/operations/getsearchresultspart.md) | :heavy_minus_sign: | N/A | |
|
||||||
13
docs/models/operations/getsearchresultsmediacontainer.md
Normal file
13
docs/models/operations/getsearchresultsmediacontainer.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetSearchResultsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 26 |
|
||||||
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||||
|
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||||
|
| `Metadata` | [][operations.GetSearchResultsMetadata](../../models/operations/getsearchresultsmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Provider` | [][operations.Provider](../../models/operations/provider.md) | :heavy_minus_sign: | N/A | |
|
||||||
41
docs/models/operations/getsearchresultsmetadata.md
Normal file
41
docs/models/operations/getsearchresultsmetadata.md
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# GetSearchResultsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `LibrarySectionID` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `Personal` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `SourceTitle` | **string* | :heavy_minus_sign: | N/A | Hera |
|
||||||
|
| `RatingKey` | **float64* | :heavy_minus_sign: | N/A | 10398 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/10398 |
|
||||||
|
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5d7768284de0ee001fcc8f52 |
|
||||||
|
| `Studio` | **string* | :heavy_minus_sign: | N/A | Paramount |
|
||||||
|
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | N/A | Mission: Impossible |
|
||||||
|
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
| `Summary` | **string* | :heavy_minus_sign: | N/A | When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score. |
|
||||||
|
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 6.6 |
|
||||||
|
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 7.1 |
|
||||||
|
| `Year` | **float64* | :heavy_minus_sign: | N/A | 1996 |
|
||||||
|
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Expect the impossible. |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/10398/thumb/1679505055 |
|
||||||
|
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/10398/art/1679505055 |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 6612628 |
|
||||||
|
| `OriginallyAvailableAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 1996-05-22 00:00:00 +0000 UTC |
|
||||||
|
| `AddedAt` | **float64* | :heavy_minus_sign: | N/A | 1589234571 |
|
||||||
|
| `UpdatedAt` | **float64* | :heavy_minus_sign: | N/A | 1679505055 |
|
||||||
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||||
|
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||||
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/10501 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||||
|
| `Media` | [][operations.GetSearchResultsMedia](../../models/operations/getsearchresultsmedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Genre` | [][operations.GetSearchResultsGenre](../../models/operations/getsearchresultsgenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Director` | [][operations.GetSearchResultsDirector](../../models/operations/getsearchresultsdirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Writer` | [][operations.GetSearchResultsWriter](../../models/operations/getsearchresultswriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Country` | [][operations.GetSearchResultsCountry](../../models/operations/getsearchresultscountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Role` | [][operations.GetSearchResultsRole](../../models/operations/getsearchresultsrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
15
docs/models/operations/getsearchresultspart.md
Normal file
15
docs/models/operations/getsearchresultspart.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetSearchResultsPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
| `ID` | **float64* | :heavy_minus_sign: | N/A | 26610 |
|
||||||
|
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/26610/1589234571/file.mkv |
|
||||||
|
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 6612628 |
|
||||||
|
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 3926903851 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||||
8
docs/models/operations/getsearchresultsrequest.md
Normal file
8
docs/models/operations/getsearchresultsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `Query` | *string* | :heavy_check_mark: | The search query string to use | 110 |
|
||||||
11
docs/models/operations/getsearchresultsresponse.md
Normal file
11
docs/models/operations/getsearchresultsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetSearchResultsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetSearchResultsResponseBody](../../models/operations/getsearchresultsresponsebody.md) | :heavy_minus_sign: | Search Results |
|
||||||
10
docs/models/operations/getsearchresultsresponsebody.md
Normal file
10
docs/models/operations/getsearchresultsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetSearchResultsResponseBody
|
||||||
|
|
||||||
|
Search Results
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetSearchResultsMediaContainer](../../models/operations/getsearchresultsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getsearchresultsrole.md
Normal file
8
docs/models/operations/getsearchresultsrole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | Tom Cruise |
|
||||||
8
docs/models/operations/getsearchresultswriter.md
Normal file
8
docs/models/operations/getsearchresultswriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchResultsWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | **string* | :heavy_minus_sign: | N/A | David Koepp |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetServerActivitiesMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A |
|
||||||
|
| `Activity` | [][operations.Activity](../../models/operations/activity.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/getserveractivitiesresponse.md
Normal file
11
docs/models/operations/getserveractivitiesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetServerActivitiesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetServerActivitiesResponseBody](../../models/operations/getserveractivitiesresponsebody.md) | :heavy_minus_sign: | The Server Activities |
|
||||||
10
docs/models/operations/getserveractivitiesresponsebody.md
Normal file
10
docs/models/operations/getserveractivitiesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetServerActivitiesResponseBody
|
||||||
|
|
||||||
|
The Server Activities
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetServerActivitiesMediaContainer](../../models/operations/getserveractivitiesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/getservercapabilitiesresponse.md
Normal file
11
docs/models/operations/getservercapabilitiesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetServerCapabilitiesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetServerCapabilitiesResponseBody](../../models/operations/getservercapabilitiesresponsebody.md) | :heavy_minus_sign: | The Server Capabilities |
|
||||||
10
docs/models/operations/getservercapabilitiesresponsebody.md
Normal file
10
docs/models/operations/getservercapabilitiesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetServerCapabilitiesResponseBody
|
||||||
|
|
||||||
|
The Server Capabilities
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.MediaContainer](../../models/operations/mediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/getserveridentitymediacontainer.md
Normal file
11
docs/models/operations/getserveridentitymediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetServerIdentityMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `Size` | **float64* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `Claimed` | **bool* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `MachineIdentifier` | **string* | :heavy_minus_sign: | N/A | 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4 |
|
||||||
|
| `Version` | **string* | :heavy_minus_sign: | N/A | 1.31.3.6868-28fc46b27 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user