mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 12:47:44 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.152.0
This commit is contained in:
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# This allows generated code to be indexed correctly
|
||||||
|
*.rb linguist-generated=false
|
||||||
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
*.gem
|
||||||
|
Gemfile.lock
|
||||||
|
.rbenv-gemsets
|
||||||
|
.DS_Store
|
||||||
74
.rubocop.yml
Normal file
74
.rubocop.yml
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
AllCops:
|
||||||
|
Exclude:
|
||||||
|
- Rakefile
|
||||||
|
TargetRubyVersion: "3.0"
|
||||||
|
Metrics:
|
||||||
|
Enabled: false
|
||||||
|
Style/IfInsideElse:
|
||||||
|
Enabled: false
|
||||||
|
Style/GuardClause:
|
||||||
|
Enabled: false
|
||||||
|
Style/ConditionalAssignment:
|
||||||
|
Enabled: false
|
||||||
|
Style/Documentation:
|
||||||
|
Enabled: false
|
||||||
|
Style/NegatedIf:
|
||||||
|
Enabled: false
|
||||||
|
Style/SoleNestedConditional:
|
||||||
|
Enabled: false
|
||||||
|
Style/AccessorGrouping:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EndAlignment:
|
||||||
|
EnforcedStyleAlignWith: start_of_line
|
||||||
|
Enabled: false
|
||||||
|
Layout/LineLength:
|
||||||
|
Enabled: false
|
||||||
|
Lint/EmptyConditionalBody:
|
||||||
|
Enabled: false
|
||||||
|
Lint/MissingSuper:
|
||||||
|
Enabled: false
|
||||||
|
Style/CaseLikeIf:
|
||||||
|
Enabled: false
|
||||||
|
#To eventually re-enable:
|
||||||
|
Layout/EmptyLines:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EmptyLinesAroundMethodBody:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EmptyLineBetweenDefs:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EmptyLineAfterGuardClause:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EmptyLinesAroundModuleBody:
|
||||||
|
Enabled: false
|
||||||
|
Layout/MultilineBlockLayout:
|
||||||
|
Enabled: false
|
||||||
|
Lint/UnusedMethodArgument:
|
||||||
|
Enabled: false
|
||||||
|
Layout/TrailingWhitespace:
|
||||||
|
Enabled: false
|
||||||
|
Style/IfUnlessModifier:
|
||||||
|
Enabled: false
|
||||||
|
Naming/AccessorMethodName:
|
||||||
|
Enabled: false
|
||||||
|
Naming/MethodParameterName:
|
||||||
|
Enabled: false
|
||||||
|
Layout/SpaceInsideHashLiteralBraces:
|
||||||
|
Enabled: false
|
||||||
|
Layout/FirstHashElementIndentation:
|
||||||
|
Enabled: false
|
||||||
|
Style/TrailingCommaInHashLiteral:
|
||||||
|
Enabled: false
|
||||||
|
Style/TrailingCommaInArrayLiteral:
|
||||||
|
Enabled: false
|
||||||
|
Layout/EmptyLinesAroundClassBody:
|
||||||
|
Enabled: false
|
||||||
|
Style/WordArray:
|
||||||
|
Enabled: false
|
||||||
|
Style/RedundantReturn: # https://github.com/rubocop/rubocop/issues/12394
|
||||||
|
Enabled: false
|
||||||
|
Style/RedundantAssignment:
|
||||||
|
Enabled: false
|
||||||
|
Lint/LiteralAsCondition:
|
||||||
|
Enabled: false
|
||||||
|
Naming/VariableNumber:
|
||||||
|
Enabled: false
|
||||||
534
.speakeasy/gen.lock
Executable file
534
.speakeasy/gen.lock
Executable file
@@ -0,0 +1,534 @@
|
|||||||
|
lockVersion: 2.0.0
|
||||||
|
id: e157bf34-6035-49ac-b4b6-57d39c4da289
|
||||||
|
management:
|
||||||
|
docChecksum: 95d4ac4070b7f9db42126fc81b258e02
|
||||||
|
docVersion: 0.0.3
|
||||||
|
speakeasyVersion: internal
|
||||||
|
generationVersion: 2.239.1
|
||||||
|
releaseVersion: 0.0.1
|
||||||
|
configChecksum: 7e45b3c44957c53c806044004f9ee4e6
|
||||||
|
repoURL: https://github.com/LukeHagar/plexruby.git
|
||||||
|
repoSubDirectory: .
|
||||||
|
installationURL: https://github.com/LukeHagar/plexruby
|
||||||
|
features:
|
||||||
|
ruby:
|
||||||
|
core: 3.2.2
|
||||||
|
flattening: 2.81.1
|
||||||
|
globalSecurity: 2.81.3
|
||||||
|
globalServerURLs: 2.82.1
|
||||||
|
nameOverrides: 2.81.1
|
||||||
|
generatedFiles:
|
||||||
|
- lib/plexapi/sdkconfiguration.rb
|
||||||
|
- lib/plexapi/server.rb
|
||||||
|
- lib/plexapi/media.rb
|
||||||
|
- lib/plexapi/activities.rb
|
||||||
|
- lib/plexapi/butler.rb
|
||||||
|
- lib/plexapi/hubs.rb
|
||||||
|
- lib/plexapi/search.rb
|
||||||
|
- lib/plexapi/library.rb
|
||||||
|
- lib/plexapi/log.rb
|
||||||
|
- lib/plexapi/playlists.rb
|
||||||
|
- lib/plexapi/security.rb
|
||||||
|
- lib/plexapi/sessions.rb
|
||||||
|
- lib/plexapi/updater.rb
|
||||||
|
- lib/plexapi/video.rb
|
||||||
|
- lib/plexapi/sdk.rb
|
||||||
|
- .rubocop.yml
|
||||||
|
- Gemfile
|
||||||
|
- Rakefile
|
||||||
|
- lib/plexapi/utils/metadata_fields.rb
|
||||||
|
- lib/plexapi/utils/utils.rb
|
||||||
|
- sorbet/config
|
||||||
|
- sorbet/rbi/annotations/.gitattributes
|
||||||
|
- sorbet/rbi/annotations/faraday.rbi
|
||||||
|
- sorbet/rbi/annotations/rainbow.rbi
|
||||||
|
- sorbet/rbi/gems/.gitattributes
|
||||||
|
- sorbet/rbi/gems/ast@2.4.2.rbi
|
||||||
|
- sorbet/rbi/gems/base64@0.1.1.rbi
|
||||||
|
- sorbet/rbi/gems/erubi@1.12.0.rbi
|
||||||
|
- sorbet/rbi/gems/faraday-multipart@1.0.4.rbi
|
||||||
|
- sorbet/rbi/gems/faraday-net_http@3.0.2.rbi
|
||||||
|
- sorbet/rbi/gems/faraday@2.7.11.rbi
|
||||||
|
- sorbet/rbi/gems/json@2.6.3.rbi
|
||||||
|
- sorbet/rbi/gems/language_server-protocol@3.17.0.3.rbi
|
||||||
|
- sorbet/rbi/gems/minitest@5.20.0.rbi
|
||||||
|
- sorbet/rbi/gems/multipart-post@2.3.0.rbi
|
||||||
|
- sorbet/rbi/gems/netrc@0.11.0.rbi
|
||||||
|
- sorbet/rbi/gems/parallel@1.23.0.rbi
|
||||||
|
- sorbet/rbi/gems/parser@3.2.2.4.rbi
|
||||||
|
- sorbet/rbi/gems/prettier_print@1.2.1.rbi
|
||||||
|
- sorbet/rbi/gems/racc@1.7.1.rbi
|
||||||
|
- sorbet/rbi/gems/rack@3.0.8.rbi
|
||||||
|
- sorbet/rbi/gems/rainbow@3.1.1.rbi
|
||||||
|
- sorbet/rbi/gems/rake@13.0.6.rbi
|
||||||
|
- sorbet/rbi/gems/rbi@0.1.1.rbi
|
||||||
|
- sorbet/rbi/gems/regexp_parser@2.8.2.rbi
|
||||||
|
- sorbet/rbi/gems/rexml@3.2.6.rbi
|
||||||
|
- sorbet/rbi/gems/rubocop-ast@1.29.0.rbi
|
||||||
|
- sorbet/rbi/gems/rubocop@1.57.1.rbi
|
||||||
|
- sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi
|
||||||
|
- sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi
|
||||||
|
- sorbet/rbi/gems/spoom@1.2.4.rbi
|
||||||
|
- sorbet/rbi/gems/syntax_tree@6.2.0.rbi
|
||||||
|
- sorbet/rbi/gems/tapioca@0.11.9.rbi
|
||||||
|
- sorbet/rbi/gems/thor@1.3.0.rbi
|
||||||
|
- sorbet/rbi/gems/unicode-display_width@2.5.0.rbi
|
||||||
|
- sorbet/rbi/gems/yard-sorbet@0.8.1.rbi
|
||||||
|
- sorbet/rbi/gems/yard@0.9.34.rbi
|
||||||
|
- sorbet/rbi/gems/yarp@0.13.0.rbi
|
||||||
|
- sorbet/tapioca/config.yml
|
||||||
|
- sorbet/tapioca/require.rb
|
||||||
|
- plexruby.gemspec
|
||||||
|
- lib/plexapi/models/operations/getservercapabilities.rb
|
||||||
|
- lib/plexapi/models/operations/getserverpreferences.rb
|
||||||
|
- lib/plexapi/models/operations/getavailableclients.rb
|
||||||
|
- lib/plexapi/models/operations/getdevices.rb
|
||||||
|
- lib/plexapi/models/operations/getserveridentity.rb
|
||||||
|
- lib/plexapi/models/operations/getmyplexaccount.rb
|
||||||
|
- lib/plexapi/models/operations/getresizedphoto.rb
|
||||||
|
- lib/plexapi/models/operations/getserverlist.rb
|
||||||
|
- lib/plexapi/models/operations/markplayed.rb
|
||||||
|
- lib/plexapi/models/operations/markunplayed.rb
|
||||||
|
- lib/plexapi/models/operations/updateplayprogress.rb
|
||||||
|
- lib/plexapi/models/operations/getserveractivities.rb
|
||||||
|
- lib/plexapi/models/operations/cancelserveractivities.rb
|
||||||
|
- lib/plexapi/models/operations/getbutlertasks.rb
|
||||||
|
- lib/plexapi/models/operations/startalltasks.rb
|
||||||
|
- lib/plexapi/models/operations/stopalltasks.rb
|
||||||
|
- lib/plexapi/models/operations/starttask.rb
|
||||||
|
- lib/plexapi/models/operations/stoptask.rb
|
||||||
|
- lib/plexapi/models/operations/getglobalhubs.rb
|
||||||
|
- lib/plexapi/models/operations/getlibraryhubs.rb
|
||||||
|
- lib/plexapi/models/operations/performsearch.rb
|
||||||
|
- lib/plexapi/models/operations/performvoicesearch.rb
|
||||||
|
- lib/plexapi/models/operations/getsearchresults.rb
|
||||||
|
- lib/plexapi/models/operations/getfilehash.rb
|
||||||
|
- lib/plexapi/models/operations/getrecentlyadded.rb
|
||||||
|
- lib/plexapi/models/operations/getlibraries.rb
|
||||||
|
- lib/plexapi/models/operations/getlibrary.rb
|
||||||
|
- lib/plexapi/models/operations/deletelibrary.rb
|
||||||
|
- lib/plexapi/models/operations/getlibraryitems.rb
|
||||||
|
- lib/plexapi/models/operations/refreshlibrary.rb
|
||||||
|
- lib/plexapi/models/operations/searchlibrary.rb
|
||||||
|
- lib/plexapi/models/operations/getmetadata.rb
|
||||||
|
- lib/plexapi/models/operations/getmetadatachildren.rb
|
||||||
|
- lib/plexapi/models/operations/getondeck.rb
|
||||||
|
- lib/plexapi/models/operations/logline.rb
|
||||||
|
- lib/plexapi/models/operations/logmultiline.rb
|
||||||
|
- lib/plexapi/models/operations/enablepapertrail.rb
|
||||||
|
- lib/plexapi/models/operations/createplaylist.rb
|
||||||
|
- lib/plexapi/models/operations/getplaylists.rb
|
||||||
|
- lib/plexapi/models/operations/getplaylist.rb
|
||||||
|
- lib/plexapi/models/operations/deleteplaylist.rb
|
||||||
|
- lib/plexapi/models/operations/updateplaylist.rb
|
||||||
|
- lib/plexapi/models/operations/getplaylistcontents.rb
|
||||||
|
- lib/plexapi/models/operations/clearplaylistcontents.rb
|
||||||
|
- lib/plexapi/models/operations/addplaylistcontents.rb
|
||||||
|
- lib/plexapi/models/operations/uploadplaylist.rb
|
||||||
|
- lib/plexapi/models/operations/gettransienttoken.rb
|
||||||
|
- lib/plexapi/models/operations/getsourceconnectioninformation.rb
|
||||||
|
- lib/plexapi/models/operations/getsessions.rb
|
||||||
|
- lib/plexapi/models/operations/getsessionhistory.rb
|
||||||
|
- lib/plexapi/models/operations/gettranscodesessions.rb
|
||||||
|
- lib/plexapi/models/operations/stoptranscodesession.rb
|
||||||
|
- lib/plexapi/models/operations/getupdatestatus.rb
|
||||||
|
- lib/plexapi/models/operations/checkforupdates.rb
|
||||||
|
- lib/plexapi/models/operations/applyupdates.rb
|
||||||
|
- lib/plexapi/models/operations/startuniversaltranscode.rb
|
||||||
|
- lib/plexapi/models/operations/gettimeline.rb
|
||||||
|
- lib/plexapi/models/shared/security.rb
|
||||||
|
- lib/plexruby.rb
|
||||||
|
- docs/models/operations/errors.md
|
||||||
|
- docs/models/operations/getservercapabilitiesserverresponsebody.md
|
||||||
|
- docs/models/operations/directory.md
|
||||||
|
- docs/models/operations/mediacontainer.md
|
||||||
|
- docs/models/operations/getservercapabilitiesresponsebody.md
|
||||||
|
- docs/models/operations/getservercapabilitiesresponse.md
|
||||||
|
- docs/models/operations/getserverpreferenceserrors.md
|
||||||
|
- docs/models/operations/getserverpreferencesserverresponsebody.md
|
||||||
|
- docs/models/operations/getserverpreferencesmediacontainer.md
|
||||||
|
- docs/models/operations/getserverpreferencesresponsebody.md
|
||||||
|
- docs/models/operations/getserverpreferencesresponse.md
|
||||||
|
- docs/models/operations/getavailableclientserrors.md
|
||||||
|
- docs/models/operations/getavailableclientsserverresponsebody.md
|
||||||
|
- docs/models/operations/server.md
|
||||||
|
- docs/models/operations/getavailableclientsmediacontainer.md
|
||||||
|
- docs/models/operations/getavailableclientsresponsebody.md
|
||||||
|
- docs/models/operations/getavailableclientsresponse.md
|
||||||
|
- docs/models/operations/getdeviceserrors.md
|
||||||
|
- docs/models/operations/getdevicesserverresponsebody.md
|
||||||
|
- docs/models/operations/device.md
|
||||||
|
- docs/models/operations/getdevicesmediacontainer.md
|
||||||
|
- docs/models/operations/getdevicesresponsebody.md
|
||||||
|
- docs/models/operations/getdevicesresponse.md
|
||||||
|
- docs/models/operations/getserveridentityerrors.md
|
||||||
|
- docs/models/operations/getserveridentityserverresponsebody.md
|
||||||
|
- docs/models/operations/getserveridentitymediacontainer.md
|
||||||
|
- docs/models/operations/getserveridentityresponsebody.md
|
||||||
|
- docs/models/operations/getserveridentityresponse.md
|
||||||
|
- docs/models/operations/getmyplexaccounterrors.md
|
||||||
|
- docs/models/operations/getmyplexaccountserverresponsebody.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/getresizedphotoerrors.md
|
||||||
|
- docs/models/operations/getresizedphotoresponsebody.md
|
||||||
|
- docs/models/operations/getresizedphotoresponse.md
|
||||||
|
- docs/models/operations/getserverlisterrors.md
|
||||||
|
- docs/models/operations/getserverlistserverresponsebody.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/markplayederrors.md
|
||||||
|
- docs/models/operations/markplayedresponsebody.md
|
||||||
|
- docs/models/operations/markplayedresponse.md
|
||||||
|
- docs/models/operations/markunplayedrequest.md
|
||||||
|
- docs/models/operations/markunplayederrors.md
|
||||||
|
- docs/models/operations/markunplayedresponsebody.md
|
||||||
|
- docs/models/operations/markunplayedresponse.md
|
||||||
|
- docs/models/operations/updateplayprogressrequest.md
|
||||||
|
- docs/models/operations/updateplayprogresserrors.md
|
||||||
|
- docs/models/operations/updateplayprogressresponsebody.md
|
||||||
|
- docs/models/operations/updateplayprogressresponse.md
|
||||||
|
- docs/models/operations/getserveractivitieserrors.md
|
||||||
|
- docs/models/operations/getserveractivitiesactivitiesresponsebody.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/cancelserveractivitieserrors.md
|
||||||
|
- docs/models/operations/cancelserveractivitiesresponsebody.md
|
||||||
|
- docs/models/operations/cancelserveractivitiesresponse.md
|
||||||
|
- docs/models/operations/getbutlertaskserrors.md
|
||||||
|
- docs/models/operations/getbutlertasksbutlerresponsebody.md
|
||||||
|
- docs/models/operations/butlertask.md
|
||||||
|
- docs/models/operations/butlertasks.md
|
||||||
|
- docs/models/operations/getbutlertasksresponsebody.md
|
||||||
|
- docs/models/operations/getbutlertasksresponse.md
|
||||||
|
- docs/models/operations/startalltaskserrors.md
|
||||||
|
- docs/models/operations/startalltasksresponsebody.md
|
||||||
|
- docs/models/operations/startalltasksresponse.md
|
||||||
|
- docs/models/operations/stopalltaskserrors.md
|
||||||
|
- docs/models/operations/stopalltasksresponsebody.md
|
||||||
|
- docs/models/operations/stopalltasksresponse.md
|
||||||
|
- docs/models/operations/taskname.md
|
||||||
|
- docs/models/operations/starttaskrequest.md
|
||||||
|
- docs/models/operations/starttaskerrors.md
|
||||||
|
- docs/models/operations/starttaskresponsebody.md
|
||||||
|
- docs/models/operations/starttaskresponse.md
|
||||||
|
- docs/models/operations/pathparamtaskname.md
|
||||||
|
- docs/models/operations/stoptaskrequest.md
|
||||||
|
- docs/models/operations/stoptaskerrors.md
|
||||||
|
- docs/models/operations/stoptaskresponsebody.md
|
||||||
|
- docs/models/operations/stoptaskresponse.md
|
||||||
|
- docs/models/operations/onlytransient.md
|
||||||
|
- docs/models/operations/getglobalhubsrequest.md
|
||||||
|
- docs/models/operations/getglobalhubserrors.md
|
||||||
|
- docs/models/operations/getglobalhubshubsresponsebody.md
|
||||||
|
- docs/models/operations/getglobalhubsmetadata.md
|
||||||
|
- docs/models/operations/hub.md
|
||||||
|
- docs/models/operations/getglobalhubsmediacontainer.md
|
||||||
|
- docs/models/operations/getglobalhubsresponsebody.md
|
||||||
|
- docs/models/operations/getglobalhubsresponse.md
|
||||||
|
- docs/models/operations/queryparamonlytransient.md
|
||||||
|
- docs/models/operations/getlibraryhubsrequest.md
|
||||||
|
- docs/models/operations/getlibraryhubserrors.md
|
||||||
|
- docs/models/operations/getlibraryhubshubsresponsebody.md
|
||||||
|
- docs/models/operations/getlibraryhubspart.md
|
||||||
|
- docs/models/operations/getlibraryhubsmedia.md
|
||||||
|
- docs/models/operations/getlibraryhubsgenre.md
|
||||||
|
- docs/models/operations/getlibraryhubscountry.md
|
||||||
|
- docs/models/operations/getlibraryhubsdirector.md
|
||||||
|
- docs/models/operations/getlibraryhubsrole.md
|
||||||
|
- docs/models/operations/getlibraryhubswriter.md
|
||||||
|
- docs/models/operations/getlibraryhubsmetadata.md
|
||||||
|
- docs/models/operations/getlibraryhubshub.md
|
||||||
|
- docs/models/operations/getlibraryhubsmediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryhubsresponsebody.md
|
||||||
|
- docs/models/operations/getlibraryhubsresponse.md
|
||||||
|
- docs/models/operations/performsearchrequest.md
|
||||||
|
- docs/models/operations/performsearcherrors.md
|
||||||
|
- docs/models/operations/performsearchresponsebody.md
|
||||||
|
- docs/models/operations/performsearchresponse.md
|
||||||
|
- docs/models/operations/performvoicesearchrequest.md
|
||||||
|
- docs/models/operations/performvoicesearcherrors.md
|
||||||
|
- docs/models/operations/performvoicesearchresponsebody.md
|
||||||
|
- docs/models/operations/performvoicesearchresponse.md
|
||||||
|
- docs/models/operations/getsearchresultsrequest.md
|
||||||
|
- docs/models/operations/getsearchresultserrors.md
|
||||||
|
- docs/models/operations/getsearchresultssearchresponsebody.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/getfilehasherrors.md
|
||||||
|
- docs/models/operations/getfilehashresponsebody.md
|
||||||
|
- docs/models/operations/getfilehashresponse.md
|
||||||
|
- docs/models/operations/getrecentlyaddederrors.md
|
||||||
|
- docs/models/operations/getrecentlyaddedlibraryresponsebody.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/getlibrarieserrors.md
|
||||||
|
- docs/models/operations/getlibrarieslibraryresponsebody.md
|
||||||
|
- docs/models/operations/location.md
|
||||||
|
- docs/models/operations/getlibrariesdirectory.md
|
||||||
|
- docs/models/operations/getlibrariesmediacontainer.md
|
||||||
|
- docs/models/operations/getlibrariesresponsebody.md
|
||||||
|
- docs/models/operations/getlibrariesresponse.md
|
||||||
|
- docs/models/operations/includedetails.md
|
||||||
|
- docs/models/operations/getlibraryrequest.md
|
||||||
|
- docs/models/operations/getlibraryerrors.md
|
||||||
|
- docs/models/operations/getlibrarylibraryresponsebody.md
|
||||||
|
- docs/models/operations/getlibrarydirectory.md
|
||||||
|
- docs/models/operations/filter.md
|
||||||
|
- docs/models/operations/sort.md
|
||||||
|
- docs/models/operations/field.md
|
||||||
|
- docs/models/operations/getlibrarytype.md
|
||||||
|
- docs/models/operations/operator.md
|
||||||
|
- docs/models/operations/fieldtype.md
|
||||||
|
- docs/models/operations/getlibrarymediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryresponsebody.md
|
||||||
|
- docs/models/operations/getlibraryresponse.md
|
||||||
|
- docs/models/operations/deletelibraryrequest.md
|
||||||
|
- docs/models/operations/deletelibraryerrors.md
|
||||||
|
- docs/models/operations/deletelibraryresponsebody.md
|
||||||
|
- docs/models/operations/deletelibraryresponse.md
|
||||||
|
- docs/models/operations/tag.md
|
||||||
|
- docs/models/operations/getlibraryitemsrequest.md
|
||||||
|
- docs/models/operations/getlibraryitemspart.md
|
||||||
|
- docs/models/operations/getlibraryitemsmedia.md
|
||||||
|
- docs/models/operations/getlibraryitemsgenre.md
|
||||||
|
- docs/models/operations/getlibraryitemscountry.md
|
||||||
|
- docs/models/operations/getlibraryitemsdirector.md
|
||||||
|
- docs/models/operations/getlibraryitemswriter.md
|
||||||
|
- docs/models/operations/getlibraryitemsrole.md
|
||||||
|
- docs/models/operations/getlibraryitemsmetadata.md
|
||||||
|
- docs/models/operations/getlibraryitemsmediacontainer.md
|
||||||
|
- docs/models/operations/getlibraryitemsresponsebody.md
|
||||||
|
- docs/models/operations/getlibraryitemsresponse.md
|
||||||
|
- docs/models/operations/refreshlibraryrequest.md
|
||||||
|
- docs/models/operations/refreshlibraryerrors.md
|
||||||
|
- docs/models/operations/refreshlibraryresponsebody.md
|
||||||
|
- docs/models/operations/refreshlibraryresponse.md
|
||||||
|
- docs/models/operations/type.md
|
||||||
|
- docs/models/operations/searchlibraryrequest.md
|
||||||
|
- docs/models/operations/searchlibrarymetadata.md
|
||||||
|
- docs/models/operations/searchlibrarymediacontainer.md
|
||||||
|
- docs/models/operations/searchlibraryresponsebody.md
|
||||||
|
- docs/models/operations/searchlibraryresponse.md
|
||||||
|
- docs/models/operations/getmetadatarequest.md
|
||||||
|
- docs/models/operations/getmetadataerrors.md
|
||||||
|
- docs/models/operations/getmetadatalibraryresponsebody.md
|
||||||
|
- docs/models/operations/stream.md
|
||||||
|
- docs/models/operations/getmetadatapart.md
|
||||||
|
- docs/models/operations/getmetadatamedia.md
|
||||||
|
- docs/models/operations/getmetadatagenre.md
|
||||||
|
- docs/models/operations/getmetadatacountry.md
|
||||||
|
- docs/models/operations/guids.md
|
||||||
|
- docs/models/operations/ratings.md
|
||||||
|
- docs/models/operations/getmetadatadirector.md
|
||||||
|
- docs/models/operations/getmetadatawriter.md
|
||||||
|
- docs/models/operations/getmetadatarole.md
|
||||||
|
- docs/models/operations/producer.md
|
||||||
|
- docs/models/operations/getmetadatametadata.md
|
||||||
|
- docs/models/operations/getmetadatamediacontainer.md
|
||||||
|
- docs/models/operations/getmetadataresponsebody.md
|
||||||
|
- docs/models/operations/getmetadataresponse.md
|
||||||
|
- docs/models/operations/getmetadatachildrenrequest.md
|
||||||
|
- docs/models/operations/getmetadatachildrenerrors.md
|
||||||
|
- docs/models/operations/getmetadatachildrenlibraryresponsebody.md
|
||||||
|
- docs/models/operations/getmetadatachildrendirectory.md
|
||||||
|
- docs/models/operations/getmetadatachildrenmetadata.md
|
||||||
|
- docs/models/operations/getmetadatachildrenmediacontainer.md
|
||||||
|
- docs/models/operations/getmetadatachildrenresponsebody.md
|
||||||
|
- docs/models/operations/getmetadatachildrenresponse.md
|
||||||
|
- docs/models/operations/getondeckerrors.md
|
||||||
|
- docs/models/operations/getondecklibraryresponsebody.md
|
||||||
|
- docs/models/operations/getondeckstream.md
|
||||||
|
- docs/models/operations/getondeckpart.md
|
||||||
|
- docs/models/operations/getondeckmedia.md
|
||||||
|
- docs/models/operations/getondeckguids.md
|
||||||
|
- docs/models/operations/getondeckmetadata.md
|
||||||
|
- docs/models/operations/getondeckmediacontainer.md
|
||||||
|
- docs/models/operations/getondeckresponsebody.md
|
||||||
|
- docs/models/operations/getondeckresponse.md
|
||||||
|
- docs/models/operations/level.md
|
||||||
|
- docs/models/operations/loglinerequest.md
|
||||||
|
- docs/models/operations/loglineerrors.md
|
||||||
|
- docs/models/operations/loglineresponsebody.md
|
||||||
|
- docs/models/operations/loglineresponse.md
|
||||||
|
- docs/models/operations/logmultilineerrors.md
|
||||||
|
- docs/models/operations/logmultilineresponsebody.md
|
||||||
|
- docs/models/operations/logmultilineresponse.md
|
||||||
|
- docs/models/operations/enablepapertrailerrors.md
|
||||||
|
- docs/models/operations/enablepapertrailresponsebody.md
|
||||||
|
- docs/models/operations/enablepapertrailresponse.md
|
||||||
|
- docs/models/operations/queryparamtype.md
|
||||||
|
- docs/models/operations/smart.md
|
||||||
|
- docs/models/operations/createplaylistrequest.md
|
||||||
|
- docs/models/operations/createplaylisterrors.md
|
||||||
|
- docs/models/operations/createplaylistplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/createplaylistmetadata.md
|
||||||
|
- docs/models/operations/createplaylistmediacontainer.md
|
||||||
|
- docs/models/operations/createplaylistresponsebody.md
|
||||||
|
- docs/models/operations/createplaylistresponse.md
|
||||||
|
- docs/models/operations/playlisttype.md
|
||||||
|
- docs/models/operations/queryparamsmart.md
|
||||||
|
- docs/models/operations/getplaylistsrequest.md
|
||||||
|
- docs/models/operations/getplaylistserrors.md
|
||||||
|
- docs/models/operations/getplaylistsplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistsmetadata.md
|
||||||
|
- docs/models/operations/getplaylistsmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistsresponse.md
|
||||||
|
- docs/models/operations/getplaylistrequest.md
|
||||||
|
- docs/models/operations/getplaylisterrors.md
|
||||||
|
- docs/models/operations/getplaylistplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistmetadata.md
|
||||||
|
- docs/models/operations/getplaylistmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistresponse.md
|
||||||
|
- docs/models/operations/deleteplaylistrequest.md
|
||||||
|
- docs/models/operations/deleteplaylisterrors.md
|
||||||
|
- docs/models/operations/deleteplaylistresponsebody.md
|
||||||
|
- docs/models/operations/deleteplaylistresponse.md
|
||||||
|
- docs/models/operations/updateplaylistrequest.md
|
||||||
|
- docs/models/operations/updateplaylisterrors.md
|
||||||
|
- docs/models/operations/updateplaylistresponsebody.md
|
||||||
|
- docs/models/operations/updateplaylistresponse.md
|
||||||
|
- docs/models/operations/getplaylistcontentsrequest.md
|
||||||
|
- docs/models/operations/getplaylistcontentserrors.md
|
||||||
|
- docs/models/operations/getplaylistcontentsplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistcontentspart.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmedia.md
|
||||||
|
- docs/models/operations/getplaylistcontentsgenre.md
|
||||||
|
- docs/models/operations/getplaylistcontentscountry.md
|
||||||
|
- docs/models/operations/getplaylistcontentsdirector.md
|
||||||
|
- docs/models/operations/getplaylistcontentswriter.md
|
||||||
|
- docs/models/operations/getplaylistcontentsrole.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmetadata.md
|
||||||
|
- docs/models/operations/getplaylistcontentsmediacontainer.md
|
||||||
|
- docs/models/operations/getplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/operations/getplaylistcontentsresponse.md
|
||||||
|
- docs/models/operations/clearplaylistcontentsrequest.md
|
||||||
|
- docs/models/operations/clearplaylistcontentserrors.md
|
||||||
|
- docs/models/operations/clearplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/operations/clearplaylistcontentsresponse.md
|
||||||
|
- docs/models/operations/addplaylistcontentsrequest.md
|
||||||
|
- docs/models/operations/addplaylistcontentserrors.md
|
||||||
|
- docs/models/operations/addplaylistcontentsplaylistsresponsebody.md
|
||||||
|
- docs/models/operations/addplaylistcontentsmetadata.md
|
||||||
|
- docs/models/operations/addplaylistcontentsmediacontainer.md
|
||||||
|
- docs/models/operations/addplaylistcontentsresponsebody.md
|
||||||
|
- docs/models/operations/addplaylistcontentsresponse.md
|
||||||
|
- docs/models/operations/force.md
|
||||||
|
- docs/models/operations/uploadplaylistrequest.md
|
||||||
|
- docs/models/operations/uploadplaylisterrors.md
|
||||||
|
- docs/models/operations/uploadplaylistresponsebody.md
|
||||||
|
- docs/models/operations/uploadplaylistresponse.md
|
||||||
|
- docs/models/operations/gettransienttokenqueryparamtype.md
|
||||||
|
- docs/models/operations/scope.md
|
||||||
|
- docs/models/operations/gettransienttokenrequest.md
|
||||||
|
- docs/models/operations/gettransienttokenerrors.md
|
||||||
|
- docs/models/operations/gettransienttokenresponsebody.md
|
||||||
|
- docs/models/operations/gettransienttokenresponse.md
|
||||||
|
- docs/models/operations/getsourceconnectioninformationrequest.md
|
||||||
|
- docs/models/operations/getsourceconnectioninformationerrors.md
|
||||||
|
- docs/models/operations/getsourceconnectioninformationresponsebody.md
|
||||||
|
- docs/models/operations/getsourceconnectioninformationresponse.md
|
||||||
|
- docs/models/operations/getsessionserrors.md
|
||||||
|
- docs/models/operations/getsessionssessionsresponsebody.md
|
||||||
|
- docs/models/operations/getsessionsstream.md
|
||||||
|
- docs/models/operations/getsessionspart.md
|
||||||
|
- docs/models/operations/getsessionsmedia.md
|
||||||
|
- docs/models/operations/user.md
|
||||||
|
- docs/models/operations/player.md
|
||||||
|
- docs/models/operations/session.md
|
||||||
|
- docs/models/operations/getsessionsmetadata.md
|
||||||
|
- docs/models/operations/getsessionsmediacontainer.md
|
||||||
|
- docs/models/operations/getsessionsresponsebody.md
|
||||||
|
- docs/models/operations/getsessionsresponse.md
|
||||||
|
- docs/models/operations/getsessionhistoryerrors.md
|
||||||
|
- docs/models/operations/getsessionhistorysessionsresponsebody.md
|
||||||
|
- docs/models/operations/getsessionhistorymetadata.md
|
||||||
|
- docs/models/operations/getsessionhistorymediacontainer.md
|
||||||
|
- docs/models/operations/getsessionhistoryresponsebody.md
|
||||||
|
- docs/models/operations/getsessionhistoryresponse.md
|
||||||
|
- docs/models/operations/gettranscodesessionserrors.md
|
||||||
|
- docs/models/operations/gettranscodesessionssessionsresponsebody.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/stoptranscodesessionerrors.md
|
||||||
|
- docs/models/operations/stoptranscodesessionresponsebody.md
|
||||||
|
- docs/models/operations/stoptranscodesessionresponse.md
|
||||||
|
- docs/models/operations/getupdatestatuserrors.md
|
||||||
|
- docs/models/operations/getupdatestatusupdaterresponsebody.md
|
||||||
|
- docs/models/operations/release.md
|
||||||
|
- docs/models/operations/getupdatestatusmediacontainer.md
|
||||||
|
- docs/models/operations/getupdatestatusresponsebody.md
|
||||||
|
- docs/models/operations/getupdatestatusresponse.md
|
||||||
|
- docs/models/operations/download.md
|
||||||
|
- docs/models/operations/checkforupdatesrequest.md
|
||||||
|
- docs/models/operations/checkforupdateserrors.md
|
||||||
|
- docs/models/operations/checkforupdatesresponsebody.md
|
||||||
|
- docs/models/operations/checkforupdatesresponse.md
|
||||||
|
- docs/models/operations/tonight.md
|
||||||
|
- docs/models/operations/skip.md
|
||||||
|
- docs/models/operations/applyupdatesrequest.md
|
||||||
|
- docs/models/operations/applyupdateserrors.md
|
||||||
|
- docs/models/operations/applyupdatesresponsebody.md
|
||||||
|
- docs/models/operations/applyupdatesresponse.md
|
||||||
|
- docs/models/operations/startuniversaltranscoderequest.md
|
||||||
|
- docs/models/operations/startuniversaltranscodeerrors.md
|
||||||
|
- docs/models/operations/startuniversaltranscoderesponsebody.md
|
||||||
|
- docs/models/operations/startuniversaltranscoderesponse.md
|
||||||
|
- docs/models/operations/state.md
|
||||||
|
- docs/models/operations/gettimelinerequest.md
|
||||||
|
- docs/models/operations/gettimelineerrors.md
|
||||||
|
- docs/models/operations/gettimelineresponsebody.md
|
||||||
|
- docs/models/operations/gettimelineresponse.md
|
||||||
|
- docs/models/shared/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
|
||||||
6
Gemfile
Normal file
6
Gemfile
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
source 'https://rubygems.org'
|
||||||
|
|
||||||
|
# Specify your gem's dependencies in openapi.gemspec
|
||||||
|
gemspec
|
||||||
196
README.md
Normal file
196
README.md
Normal file
@@ -0,0 +1,196 @@
|
|||||||
|
# plexruby
|
||||||
|
|
||||||
|
<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
|
||||||
|
gem install specific_install
|
||||||
|
gem specific_install https://github.com/LukeHagar/plexruby
|
||||||
|
```
|
||||||
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
## SDK Example Usage
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require_relative plexruby
|
||||||
|
|
||||||
|
|
||||||
|
s = ::OpenApiSDK::PlexAPI.new
|
||||||
|
s.config_security(
|
||||||
|
security=Shared::Security.new(
|
||||||
|
access_token="<YOUR_API_KEY_HERE>",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.server.get_server_capabilities()
|
||||||
|
|
||||||
|
if ! res.two_hundred_application_json_object.nil?
|
||||||
|
# handle response
|
||||||
|
end
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
|
|
||||||
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
|
## Available Resources and Operations
|
||||||
|
|
||||||
|
### [Server](docs/sdks/server/README.md)
|
||||||
|
|
||||||
|
* [get_server_capabilities](docs/sdks/server/README.md#get_server_capabilities) - Server Capabilities
|
||||||
|
* [get_server_preferences](docs/sdks/server/README.md#get_server_preferences) - Get Server Preferences
|
||||||
|
* [get_available_clients](docs/sdks/server/README.md#get_available_clients) - Get Available Clients
|
||||||
|
* [get_devices](docs/sdks/server/README.md#get_devices) - Get Devices
|
||||||
|
* [get_server_identity](docs/sdks/server/README.md#get_server_identity) - Get Server Identity
|
||||||
|
* [get_my_plex_account](docs/sdks/server/README.md#get_my_plex_account) - Get MyPlex Account
|
||||||
|
* [get_resized_photo](docs/sdks/server/README.md#get_resized_photo) - Get a Resized Photo
|
||||||
|
* [get_server_list](docs/sdks/server/README.md#get_server_list) - Get Server List
|
||||||
|
|
||||||
|
### [Media](docs/sdks/media/README.md)
|
||||||
|
|
||||||
|
* [mark_played](docs/sdks/media/README.md#mark_played) - Mark Media Played
|
||||||
|
* [mark_unplayed](docs/sdks/media/README.md#mark_unplayed) - Mark Media Unplayed
|
||||||
|
* [update_play_progress](docs/sdks/media/README.md#update_play_progress) - Update Media Play Progress
|
||||||
|
|
||||||
|
### [Activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
|
* [get_server_activities](docs/sdks/activities/README.md#get_server_activities) - Get Server Activities
|
||||||
|
* [cancel_server_activities](docs/sdks/activities/README.md#cancel_server_activities) - Cancel Server Activities
|
||||||
|
|
||||||
|
### [Butler](docs/sdks/butler/README.md)
|
||||||
|
|
||||||
|
* [get_butler_tasks](docs/sdks/butler/README.md#get_butler_tasks) - Get Butler tasks
|
||||||
|
* [start_all_tasks](docs/sdks/butler/README.md#start_all_tasks) - Start all Butler tasks
|
||||||
|
* [stop_all_tasks](docs/sdks/butler/README.md#stop_all_tasks) - Stop all Butler tasks
|
||||||
|
* [start_task](docs/sdks/butler/README.md#start_task) - Start a single Butler task
|
||||||
|
* [stop_task](docs/sdks/butler/README.md#stop_task) - Stop a single Butler task
|
||||||
|
|
||||||
|
### [Hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
|
* [get_global_hubs](docs/sdks/hubs/README.md#get_global_hubs) - Get Global Hubs
|
||||||
|
* [get_library_hubs](docs/sdks/hubs/README.md#get_library_hubs) - Get library specific hubs
|
||||||
|
|
||||||
|
### [Search](docs/sdks/search/README.md)
|
||||||
|
|
||||||
|
* [perform_search](docs/sdks/search/README.md#perform_search) - Perform a search
|
||||||
|
* [perform_voice_search](docs/sdks/search/README.md#perform_voice_search) - Perform a voice search
|
||||||
|
* [get_search_results](docs/sdks/search/README.md#get_search_results) - Get Search Results
|
||||||
|
|
||||||
|
### [Library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
|
* [get_file_hash](docs/sdks/library/README.md#get_file_hash) - Get Hash Value
|
||||||
|
* [get_recently_added](docs/sdks/library/README.md#get_recently_added) - Get Recently Added
|
||||||
|
* [get_libraries](docs/sdks/library/README.md#get_libraries) - Get All Libraries
|
||||||
|
* [get_library](docs/sdks/library/README.md#get_library) - Get Library Details
|
||||||
|
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
|
||||||
|
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
|
||||||
|
* [refresh_library](docs/sdks/library/README.md#refresh_library) - Refresh Library
|
||||||
|
* [search_library](docs/sdks/library/README.md#search_library) - Search Library
|
||||||
|
* [get_metadata](docs/sdks/library/README.md#get_metadata) - Get Items Metadata
|
||||||
|
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
||||||
|
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||||
|
|
||||||
|
### [Log](docs/sdks/log/README.md)
|
||||||
|
|
||||||
|
* [log_line](docs/sdks/log/README.md#log_line) - Logging a single line message.
|
||||||
|
* [log_multi_line](docs/sdks/log/README.md#log_multi_line) - Logging a multi-line message
|
||||||
|
* [enable_paper_trail](docs/sdks/log/README.md#enable_paper_trail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [Playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
|
* [create_playlist](docs/sdks/playlists/README.md#create_playlist) - Create a Playlist
|
||||||
|
* [get_playlists](docs/sdks/playlists/README.md#get_playlists) - Get All Playlists
|
||||||
|
* [get_playlist](docs/sdks/playlists/README.md#get_playlist) - Retrieve Playlist
|
||||||
|
* [delete_playlist](docs/sdks/playlists/README.md#delete_playlist) - Deletes a Playlist
|
||||||
|
* [update_playlist](docs/sdks/playlists/README.md#update_playlist) - Update a Playlist
|
||||||
|
* [get_playlist_contents](docs/sdks/playlists/README.md#get_playlist_contents) - Retrieve Playlist Contents
|
||||||
|
* [clear_playlist_contents](docs/sdks/playlists/README.md#clear_playlist_contents) - Delete Playlist Contents
|
||||||
|
* [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
|
||||||
|
* [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
|
||||||
|
|
||||||
|
### [Security](docs/sdks/security/README.md)
|
||||||
|
|
||||||
|
* [get_transient_token](docs/sdks/security/README.md#get_transient_token) - Get a Transient Token.
|
||||||
|
* [get_source_connection_information](docs/sdks/security/README.md#get_source_connection_information) - Get Source Connection Information
|
||||||
|
|
||||||
|
### [Sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
|
* [get_sessions](docs/sdks/sessions/README.md#get_sessions) - Get Active Sessions
|
||||||
|
* [get_session_history](docs/sdks/sessions/README.md#get_session_history) - Get Session History
|
||||||
|
* [get_transcode_sessions](docs/sdks/sessions/README.md#get_transcode_sessions) - Get Transcode Sessions
|
||||||
|
* [stop_transcode_session](docs/sdks/sessions/README.md#stop_transcode_session) - Stop a Transcode Session
|
||||||
|
|
||||||
|
### [Updater](docs/sdks/updater/README.md)
|
||||||
|
|
||||||
|
* [get_update_status](docs/sdks/updater/README.md#get_update_status) - Querying status of updates
|
||||||
|
* [check_for_updates](docs/sdks/updater/README.md#check_for_updates) - Checking for updates
|
||||||
|
* [apply_updates](docs/sdks/updater/README.md#apply_updates) - Apply Updates
|
||||||
|
|
||||||
|
### [Video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [start_universal_transcode](docs/sdks/video/README.md#start_universal_transcode) - Start Universal Transcode
|
||||||
|
* [get_timeline](docs/sdks/video/README.md#get_timeline) - Get the timeline for a media item
|
||||||
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Server Selection [server] -->
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
### Select Server by Index
|
||||||
|
|
||||||
|
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||||
|
|
||||||
|
| # | Server | Variables |
|
||||||
|
| - | ------ | --------- |
|
||||||
|
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Variables
|
||||||
|
|
||||||
|
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
||||||
|
* `protocol: ServerProtocol`
|
||||||
|
* `ip: String`
|
||||||
|
* `port: String`
|
||||||
|
|
||||||
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
|
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
|
||||||
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
|
<!-- 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)
|
||||||
9
RELEASES.md
Normal file
9
RELEASES.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
|
||||||
|
|
||||||
|
## 2024-01-25 00:52:12
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc 0.0.3
|
||||||
|
- Speakeasy CLI 1.152.0 (2.239.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [ruby v0.0.1] .
|
||||||
21
Rakefile
Normal file
21
Rakefile
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# typed: true
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require 'bundler/gem_tasks'
|
||||||
|
require 'minitest/test_task'
|
||||||
|
require 'rubocop/rake_task'
|
||||||
|
|
||||||
|
RuboCop::RakeTask.new
|
||||||
|
|
||||||
|
Minitest::TestTask.create
|
||||||
|
|
||||||
|
# So far default is working - leaving this here for reference.
|
||||||
|
|
||||||
|
# Minitest::TestTask.create(:test) do |t|
|
||||||
|
# t.libs << 'test'
|
||||||
|
# t.libs << 'lib'
|
||||||
|
# t.warning = false
|
||||||
|
# t.test_globs = ['test/**/*_test.rb']
|
||||||
|
# end
|
||||||
|
|
||||||
|
task :default => :test
|
||||||
21
USAGE.md
Normal file
21
USAGE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
```ruby
|
||||||
|
require_relative plexruby
|
||||||
|
|
||||||
|
|
||||||
|
s = ::OpenApiSDK::PlexAPI.new
|
||||||
|
s.config_security(
|
||||||
|
security=Shared::Security.new(
|
||||||
|
access_token="<YOUR_API_KEY_HERE>",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.server.get_server_capabilities()
|
||||||
|
|
||||||
|
if ! res.two_hundred_application_json_object.nil?
|
||||||
|
# handle response
|
||||||
|
end
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
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` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `cancellable` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `user_id` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `subtitle` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `progress` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `context` | [T.nilable(Operations::Context)](../../models/operations/context.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/addplaylistcontentserrors.md
Normal file
10
docs/models/operations/addplaylistcontentserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
11
docs/models/operations/addplaylistcontentsmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AddPlaylistContentsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `leaf_count_added` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `leaf_count_requested` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `metadata` | T::Array<[Operations::AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)> | :heavy_minus_sign: | N/A | [{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}] |
|
||||||
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
20
docs/models/operations/addplaylistcontentsmetadata.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# AddPlaylistContentsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `rating_key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | 94 |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/94/items |
|
||||||
|
| `guid` | *T.nilable(String)* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | A great playlist |
|
||||||
|
| `summary` | *T.nilable(String)* | :heavy_minus_sign: | N/A | One of my great playlists |
|
||||||
|
| `smart` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlist_type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `composite` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
|
||||||
|
| `duration` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 423000 |
|
||||||
|
| `leaf_count` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `added_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705716458 |
|
||||||
|
| `updated_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705800070 |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsPlaylistsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::AddPlaylistContentsErrors](../../models/operations/addplaylistcontentserrors.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 |
|
||||||
|
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||||
|
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||||
|
| `uri` | *String* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
|
||||||
|
| `play_queue_id` | *T.nilable(Float)* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
|
||||||
12
docs/models/operations/addplaylistcontentsresponse.md
Normal file
12
docs/models/operations/addplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# AddPlaylistContentsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::AddPlaylistContentsResponseBody)](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::AddPlaylistContentsPlaylistsResponseBody)](../../models/operations/addplaylistcontentsplaylistsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/addplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsResponseBody
|
||||||
|
|
||||||
|
Playlist Updated
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `media_container` | [T.nilable(Operations::AddPlaylistContentsMediaContainer)](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/applyupdateserrors.md
Normal file
10
docs/models/operations/applyupdateserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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` | [T.nilable(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` | [T.nilable(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`. |
|
||||||
11
docs/models/operations/applyupdatesresponse.md
Normal file
11
docs/models/operations/applyupdatesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ApplyUpdatesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::ApplyUpdatesResponseBody)](../../models/operations/applyupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/applyupdatesresponsebody.md
Normal file
10
docs/models/operations/applyupdatesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::ApplyUpdatesErrors](../../models/operations/applyupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
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` | *T.nilable(String)* | :heavy_minus_sign: | N/A | BackupDatabase |
|
||||||
|
| `interval` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `schedule_randomized` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `enabled` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Backup Database |
|
||||||
|
| `description` | *T.nilable(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 |
|
||||||
|
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||||
|
| `butler_task` | T::Array<[Operations::ButlerTask](../../models/operations/butlertask.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/cancelserveractivitieserrors.md
Normal file
10
docs/models/operations/cancelserveractivitieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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 |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `activity_uuid` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
||||||
11
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
11
docs/models/operations/cancelserveractivitiesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CancelServerActivitiesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::CancelServerActivitiesResponseBody)](../../models/operations/cancelserveractivitiesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/cancelserveractivitiesresponsebody.md
Normal file
10
docs/models/operations/cancelserveractivitiesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::CancelServerActivitiesErrors](../../models/operations/cancelserveractivitieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/checkforupdateserrors.md
Normal file
10
docs/models/operations/checkforupdateserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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` | [T.nilable(Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
|
||||||
11
docs/models/operations/checkforupdatesresponse.md
Normal file
11
docs/models/operations/checkforupdatesresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CheckForUpdatesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::CheckForUpdatesResponseBody)](../../models/operations/checkforupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/checkforupdatesresponsebody.md
Normal file
10
docs/models/operations/checkforupdatesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::CheckForUpdatesErrors](../../models/operations/checkforupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/clearplaylistcontentserrors.md
Normal file
10
docs/models/operations/clearplaylistcontentserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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 |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist |
|
||||||
11
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
11
docs/models/operations/clearplaylistcontentsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ClearPlaylistContentsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::ClearPlaylistContentsResponseBody)](../../models/operations/clearplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/clearplaylistcontentsresponsebody.md
Normal file
10
docs/models/operations/clearplaylistcontentsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::ClearPlaylistContentsErrors](../../models/operations/clearplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
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 |
|
||||||
|
| -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
|
| `library_section_id` | *T.nilable(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` | *T.nilable(String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
10
docs/models/operations/createplaylisterrors.md
Normal file
10
docs/models/operations/createplaylisterrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
9
docs/models/operations/createplaylistmediacontainer.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CreatePlaylistMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 7 |
|
||||||
|
| `metadata` | T::Array<[Operations::CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)> | :heavy_minus_sign: | N/A | [{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}] |
|
||||||
23
docs/models/operations/createplaylistmetadata.md
Normal file
23
docs/models/operations/createplaylistmetadata.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# CreatePlaylistMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `rating_key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | 96 |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/96/items |
|
||||||
|
| `guid` | *T.nilable(String)* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | A Great Playlist |
|
||||||
|
| `summary` | *T.nilable(String)* | :heavy_minus_sign: | N/A | What a great playlist |
|
||||||
|
| `smart` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlist_type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `icon` | *T.nilable(String)* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||||
|
| `view_count` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `last_viewed_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||||
|
| `leaf_count` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `added_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705719589 |
|
||||||
|
| `updated_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705724593 |
|
||||||
|
| `composite` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
|
||||||
|
| `duration` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 141000 |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistPlaylistsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::CreatePlaylistErrors](../../models/operations/createplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
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::QueryParamType](../../models/operations/queryparamtype.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_check_mark: | the content URI for the playlist |
|
||||||
|
| `play_queue_id` | *T.nilable(Float)* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||||
12
docs/models/operations/createplaylistresponse.md
Normal file
12
docs/models/operations/createplaylistresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# CreatePlaylistResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::CreatePlaylistResponseBody)](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::CreatePlaylistPlaylistsResponseBody)](../../models/operations/createplaylistplaylistsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/createplaylistresponsebody.md
Normal file
10
docs/models/operations/createplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistResponseBody
|
||||||
|
|
||||||
|
returns all playlists
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `media_container` | [T.nilable(Operations::CreatePlaylistMediaContainer)](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/deletelibraryerrors.md
Normal file
10
docs/models/operations/deletelibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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 |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||||
|
| `section_id` | *Float* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
||||||
11
docs/models/operations/deletelibraryresponse.md
Normal file
11
docs/models/operations/deletelibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DeleteLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::DeleteLibraryResponseBody)](../../models/operations/deletelibraryresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/deletelibraryresponsebody.md
Normal file
10
docs/models/operations/deletelibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::DeleteLibraryErrors](../../models/operations/deletelibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/deleteplaylisterrors.md
Normal file
10
docs/models/operations/deleteplaylisterrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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 |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `playlist_id` | *Float* | :heavy_check_mark: | the ID of the playlist |
|
||||||
11
docs/models/operations/deleteplaylistresponse.md
Normal file
11
docs/models/operations/deleteplaylistresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DeletePlaylistResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::DeletePlaylistResponseBody)](../../models/operations/deleteplaylistresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/deleteplaylistresponsebody.md
Normal file
10
docs/models/operations/deleteplaylistresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::DeletePlaylistErrors](../../models/operations/deleteplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
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` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `name` | *T.nilable(String)* | :heavy_minus_sign: | N/A | iPhone |
|
||||||
|
| `platform` | *T.nilable(String)* | :heavy_minus_sign: | N/A | iOS |
|
||||||
|
| `client_identifier` | *T.nilable(String)* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `created_at` | *T.nilable(Float)* | :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` | *T.nilable(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` | *T.nilable(Float)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `title` | *T.nilable(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 |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
10
docs/models/operations/enablepapertrailerrors.md
Normal file
10
docs/models/operations/enablepapertrailerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/enablepapertrailresponse.md
Normal file
11
docs/models/operations/enablepapertrailresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# EnablePaperTrailResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::EnablePaperTrailResponseBody)](../../models/operations/enablepapertrailresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/enablepapertrailresponsebody.md
Normal file
10
docs/models/operations/enablepapertrailresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::EnablePaperTrailErrors](../../models/operations/enablepapertrailerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/errors.md
Normal file
10
docs/models/operations/errors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Errors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/field.md
Normal file
11
docs/models/operations/field.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Field
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Label |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | tag |
|
||||||
|
| `sub_type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | bitrate |
|
||||||
9
docs/models/operations/fieldtype.md
Normal file
9
docs/models/operations/fieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# FieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | resolution |
|
||||||
|
| `operator` | T::Array<[Operations::Operator](../../models/operations/operator.md)> | :heavy_minus_sign: | N/A | [{"key":"=","title":"is"}] |
|
||||||
12
docs/models/operations/filter.md
Normal file
12
docs/models/operations/filter.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Filter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
|
| `filter` | *T.nilable(String)* | :heavy_minus_sign: | N/A | label |
|
||||||
|
| `filter_type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | string |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /library/sections/1/label |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Labels |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | filter |
|
||||||
15
docs/models/operations/force.md
Normal file
15
docs/models/operations/force.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# 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 |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 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` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Comedy |
|
||||||
10
docs/models/operations/getavailableclientserrors.md
Normal file
10
docs/models/operations/getavailableclientserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAvailableClientsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAvailableClientsMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
|
| `size` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `server` | T::Array<[Operations::Server](../../models/operations/server.md)> | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/getavailableclientsresponse.md
Normal file
12
docs/models/operations/getavailableclientsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAvailableClientsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::GetAvailableClientsResponseBody)](../../models/operations/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetAvailableClientsServerResponseBody)](../../models/operations/getavailableclientsserverresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/getavailableclientsresponsebody.md
Normal file
10
docs/models/operations/getavailableclientsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAvailableClientsResponseBody
|
||||||
|
|
||||||
|
Available Clients
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `media_container` | [T.nilable(Operations::GetAvailableClientsMediaContainer)](../../models/operations/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAvailableClientsServerResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetAvailableClientsErrors](../../models/operations/getavailableclientserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getbutlertasksbutlerresponsebody.md
Normal file
10
docs/models/operations/getbutlertasksbutlerresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetButlerTasksButlerResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetButlerTasksErrors](../../models/operations/getbutlertaskserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getbutlertaskserrors.md
Normal file
10
docs/models/operations/getbutlertaskserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetButlerTasksErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
12
docs/models/operations/getbutlertasksresponse.md
Normal file
12
docs/models/operations/getbutlertasksresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetButlerTasksResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::GetButlerTasksResponseBody)](../../models/operations/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetButlerTasksButlerResponseBody)](../../models/operations/getbutlertasksbutlerresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
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 |
|
||||||
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
| `butler_tasks` | [T.nilable(Operations::ButlerTasks)](../../models/operations/butlertasks.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getdeviceserrors.md
Normal file
10
docs/models/operations/getdeviceserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetDevicesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 151 |
|
||||||
|
| `identifier` | *T.nilable(String)* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
|
||||||
|
| `device` | T::Array<[Operations::Device](../../models/operations/device.md)> | :heavy_minus_sign: | N/A | |
|
||||||
12
docs/models/operations/getdevicesresponse.md
Normal file
12
docs/models/operations/getdevicesresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetDevicesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::GetDevicesResponseBody)](../../models/operations/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetDevicesServerResponseBody)](../../models/operations/getdevicesserverresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
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 |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `media_container` | [T.nilable(Operations::GetDevicesMediaContainer)](../../models/operations/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getdevicesserverresponsebody.md
Normal file
10
docs/models/operations/getdevicesserverresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetDevicesServerResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetDevicesErrors](../../models/operations/getdeviceserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getfilehasherrors.md
Normal file
10
docs/models/operations/getfilehasherrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetFileHashErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
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` | *T.nilable(Float)* | :heavy_minus_sign: | Item type | |
|
||||||
11
docs/models/operations/getfilehashresponse.md
Normal file
11
docs/models/operations/getfilehashresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetFileHashResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(Operations::GetFileHashResponseBody)](../../models/operations/getfilehashresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/getfilehashresponsebody.md
Normal file
10
docs/models/operations/getfilehashresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetFileHashResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetFileHashErrors](../../models/operations/getfilehasherrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getglobalhubserrors.md
Normal file
10
docs/models/operations/getglobalhubserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGlobalHubsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
10
docs/models/operations/getglobalhubshubsresponsebody.md
Normal file
10
docs/models/operations/getglobalhubshubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGlobalHubsHubsResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetGlobalHubsErrors](../../models/operations/getglobalhubserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
11
docs/models/operations/getglobalhubsmediacontainer.md
Normal file
File diff suppressed because one or more lines are too long
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
24
docs/models/operations/getglobalhubsmetadata.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# GetGlobalHubsMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `rating_key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | 57070 |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/57070/items |
|
||||||
|
| `guid` | *T.nilable(String)* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | playlist |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | November Movie Day |
|
||||||
|
| `title_sort` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Tracks |
|
||||||
|
| `summary` | *T.nilable(String)* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `smart` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `playlist_type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | video |
|
||||||
|
| `composite` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /playlists/57070/composite/1668787730 |
|
||||||
|
| `icon` | *T.nilable(String)* | :heavy_minus_sign: | N/A | playlist://image.smart |
|
||||||
|
| `view_count` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||||
|
| `last_viewed_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1668787732 |
|
||||||
|
| `duration` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 16873000 |
|
||||||
|
| `leaf_count` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 3 |
|
||||||
|
| `added_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1668779618 |
|
||||||
|
| `updated_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1668787730 |
|
||||||
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` | *T.nilable(Float)* | :heavy_minus_sign: | The number of items to return with each hub. |
|
||||||
|
| `only_transient` | [T.nilable(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). |
|
||||||
12
docs/models/operations/getglobalhubsresponse.md
Normal file
12
docs/models/operations/getglobalhubsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetGlobalHubsResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::GetGlobalHubsResponseBody)](../../models/operations/getglobalhubsresponsebody.md) | :heavy_minus_sign: | returns global hubs |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetGlobalHubsHubsResponseBody)](../../models/operations/getglobalhubshubsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
10
docs/models/operations/getglobalhubsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetGlobalHubsResponseBody
|
||||||
|
|
||||||
|
returns global hubs
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `media_container` | [T.nilable(Operations::GetGlobalHubsMediaContainer)](../../models/operations/getglobalhubsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
28
docs/models/operations/getlibrariesdirectory.md
Normal file
28
docs/models/operations/getlibrariesdirectory.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# GetLibrariesDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
|
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `art` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||||
|
| `composite` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
|
| `filters` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `refreshing` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `thumb` | *T.nilable(String)* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `type` | *T.nilable(String)* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `agent` | *T.nilable(String)* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||||
|
| `scanner` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||||
|
| `language` | *T.nilable(String)* | :heavy_minus_sign: | N/A | en-US |
|
||||||
|
| `uuid` | *T.nilable(String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `updated_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705615634 |
|
||||||
|
| `created_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1654131312 |
|
||||||
|
| `scanned_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 1705615584 |
|
||||||
|
| `content` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `directory` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `content_changed_at` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 3192854 |
|
||||||
|
| `hidden` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `location` | T::Array<[Operations::Location](../../models/operations/location.md)> | :heavy_minus_sign: | N/A | [{"id":1,"path":"/movies"}] |
|
||||||
10
docs/models/operations/getlibrarieserrors.md
Normal file
10
docs/models/operations/getlibrarieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrariesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
10
docs/models/operations/getlibrarieslibraryresponsebody.md
Normal file
10
docs/models/operations/getlibrarieslibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrariesLibraryResponseBody
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[Operations::GetLibrariesErrors](../../models/operations/getlibrarieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
11
docs/models/operations/getlibrariesmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrariesMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *T.nilable(Integer)* | :heavy_minus_sign: | N/A | 5 |
|
||||||
|
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `title1` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Plex Library |
|
||||||
|
| `directory` | T::Array<[Operations::GetLibrariesDirectory](../../models/operations/getlibrariesdirectory.md)> | :heavy_minus_sign: | N/A | [{"Location":[{"id":1,"path":"/movies"}],"agent":"tv.plex.agents.movie","allowSync":true,"art":"/:/resources/movie-fanart.jpg","composite":"/library/sections/1/composite/1705615584","content":true,"contentChangedAt":3192854,"createdAt":1654131312,"directory":true,"filters":true,"hidden":0,"key":"1","language":"en-US","refreshing":false,"scannedAt":1705615584,"scanner":"Plex Movie","thumb":"/:/resources/movie.png","title":"Movies","type":"movie","updatedAt":1705615634,"uuid":"322a231a-b7f7-49f5-920f-14c61199cd30"}] |
|
||||||
12
docs/models/operations/getlibrariesresponse.md
Normal file
12
docs/models/operations/getlibrariesresponse.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibrariesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `two_hundred_application_json_object` | [T.nilable(Operations::GetLibrariesResponseBody)](../../models/operations/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||||
|
| `four_hundred_and_one_application_json_object` | [T.nilable(Operations::GetLibrariesLibraryResponseBody)](../../models/operations/getlibrarieslibraryresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
10
docs/models/operations/getlibrariesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrariesResponseBody
|
||||||
|
|
||||||
|
The libraries available on the Server
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `media_container` | [T.nilable(Operations::GetLibrariesMediaContainer)](../../models/operations/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
12
docs/models/operations/getlibrarydirectory.md
Normal file
12
docs/models/operations/getlibrarydirectory.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `key` | *T.nilable(String)* | :heavy_minus_sign: | N/A | search?type=1 |
|
||||||
|
| `title` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Search... |
|
||||||
|
| `secondary` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `prompt` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Search Movies |
|
||||||
|
| `search` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
10
docs/models/operations/getlibraryerrors.md
Normal file
10
docs/models/operations/getlibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
8
docs/models/operations/getlibraryhubscountry.md
Normal file
8
docs/models/operations/getlibraryhubscountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||||
|
| `tag` | *T.nilable(String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||||
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
8
docs/models/operations/getlibraryhubsdirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryHubsDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `tag` | *T.nilable(String)* | :heavy_minus_sign: | N/A | Nathan Greno |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user