Compare commits

...

83 Commits

Author SHA1 Message Date
speakeasybot
da1cc22aa5 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.615.2 2025-10-13 00:34:57 +00:00
speakeasybot
81ecd024e7 ## Java SDK Changes Detected:
* `plex-api.butler.startTask()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `plex-api.butler.stopTask()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `plex-api.updater.applyUpdates()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `plex-api.general.getServerInfo()`: **Added**
* `plex-api.general.getIdentity()`: **Added**
* `plex-api.general.getSourceConnectionInformation()`: **Added**
* `plex-api.general.getTransientToken()`: **Added**
* `plex-api.events.getNotifications()`: **Added**
* `plex-api.events.connectWebSocket()`: **Added**
* `plex-api.preferences.getAllPreferences()`: **Added**
* `plex-api.preferences.setPreferences()`: **Added**
* `plex-api.preferences.getPreference()`: **Added**
* `plex-api.rate.setRating()`: **Added**
* `plex-api.timeline.markPlayed()`: **Added**
* `plex-api.timeline.report()`: **Added**
* `plex-api.timeline.unscrobble()`: **Added**
* `plex-api.activities.listActivities()`: **Added**
* `plex-api.activities.cancelActivity()`: **Added**
* `plex-api.butler.stopTasks()`: **Added**
* `plex-api.butler.getTasks()`: **Added**
* `plex-api.butler.startTasks()`: **Added**
* `plex-api.downloadQueue.createDownloadQueue()`: **Added**
* `plex-api.downloadQueue.getDownloadQueue()`: **Added**
* `plex-api.downloadQueue.addDownloadQueueItems()`: **Added**
* `plex-api.downloadQueue.listDownloadQueueItems()`: **Added**
* `plex-api.downloadQueue.getItemDecision()`: **Added**
* `plex-api.downloadQueue.getDownloadQueueMedia()`: **Added**
* `plex-api.downloadQueue.removeDownloadQueueItems()`: **Added**
* `plex-api.downloadQueue.getDownloadQueueItems()`: **Added**
* `plex-api.downloadQueue.restartProcessingDownloadQueueItems()`: **Added**
* `plex-api.hubs.getAllHubs()`: **Added**
* `plex-api.hubs.getContinueWatching()`: **Added**
* `plex-api.hubs.getHubItems()`: **Added**
* `plex-api.hubs.getPromotedHubs()`: **Added**
* `plex-api.hubs.getMetadataHubs()`: **Added**
* `plex-api.hubs.getPostplayHubs()`: **Added**
* `plex-api.hubs.getRelatedHubs()`: **Added**
* `plex-api.hubs.getSectionHubs()`: **Added**
* `plex-api.hubs.resetSectionDefaults()`: **Added**
* `plex-api.hubs.listHubs()`: **Added**
* `plex-api.hubs.createCustomHub()`: **Added**
* `plex-api.hubs.moveHub()`: **Added**
* `plex-api.hubs.deleteCustomHub()`: **Added**
* `plex-api.hubs.updateHubVisibility()`: **Added**
* `plex-api.search.searchHubs()`: **Added**
* `plex-api.search.voiceSearchHubs()`: **Added**
* `plex-api.library.getLibraryItems()`: **Added**
* `plex-api.library.deleteCaches()`: **Added**
* `plex-api.library.cleanBundles()`: **Added**
* `plex-api.library.ingestTransientItem()`: **Added**
* `plex-api.library.getLibraryMatches()`: **Added**
* `plex-api.library.optimizeDatabase()`: **Added**
* `plex-api.library.getRandomArtwork()`: **Added**
* `plex-api.library.getSections()`: **Added**
* `plex-api.library.addSection()`: **Added**
* `plex-api.library.stopAllRefreshes()`: **Added**
* `plex-api.library.getSectionsPrefs()`: **Added**
* `plex-api.library.refreshSectionsMetadata()`: **Added**
* `plex-api.library.getTags()`: **Added**
* `plex-api.library.deleteMetadataItem()`: **Added**
* `plex-api.library.editMetadataItem()`: **Added**
* `plex-api.library.detectAds()`: **Added**
* `plex-api.library.getAllItemLeaves()`: **Added**
* `plex-api.library.analyzeMetadata()`: **Added**
* `plex-api.library.generateThumbs()`: **Added**
* `plex-api.library.detectCredits()`: **Added**
* `plex-api.library.getExtras()`: **Added**
* `plex-api.library.addExtras()`: **Added**
* `plex-api.library.getFile()`: **Added**
* `plex-api.library.startBifGeneration()`: **Added**
* `plex-api.library.detectIntros()`: **Added**
* `plex-api.library.createMarker()`: **Added**
* `plex-api.library.matchItem()`: **Added**
* `plex-api.library.listMatches()`: **Added**
* `plex-api.library.mergeItems()`: **Added**
* `plex-api.library.listSonicallySimilar()`: **Added**
* `plex-api.library.setItemPreferences()`: **Added**
* `plex-api.library.refreshItemsMetadata()`: **Added**
* `plex-api.library.getRelatedItems()`: **Added**
* `plex-api.library.listSimilar()`: **Added**
* `plex-api.library.splitItem()`: **Added**
* `plex-api.library.addSubtitles()`: **Added**
* `plex-api.library.getItemTree()`: **Added**
* `plex-api.library.unmatch()`: **Added**
* `plex-api.library.listTopUsers()`: **Added**
* `plex-api.library.detectVoiceActivity()`: **Added**
* `plex-api.library.getAugmentationStatus()`: **Added**
* `plex-api.library.setStreamSelection()`: **Added**
* `plex-api.library.getPerson()`: **Added**
* `plex-api.library.listPersonMedia()`: **Added**
* `plex-api.library.deleteLibrarySection()`: **Added**
* `plex-api.library.getLibraryDetails()`: **Added**
* `plex-api.library.editSection()`: **Added**
* `plex-api.library.updateItems()`: **Added**
* `plex-api.library.startAnalysis()`: **Added**
* `plex-api.library.autocomplete()`: **Added**
* `plex-api.library.getCollections()`: **Added**
* `plex-api.library.getCommon()`: **Added**
* `plex-api.library.emptyTrash()`: **Added**
* `plex-api.library.getSectionFilters()`: **Added**
* `plex-api.library.getFirstCharacters()`: **Added**
* `plex-api.library.deleteIndexes()`: **Added**
* `plex-api.library.deleteIntros()`: **Added**
* `plex-api.library.getSectionPreferences()`: **Added**
* `plex-api.library.setSectionPreferences()`: **Added**
* `plex-api.library.cancelRefresh()`: **Added**
* `plex-api.library.refreshSection()`: **Added**
* `plex-api.library.getAvailableSorts()`: **Added**
* `plex-api.library.getStreamLevels()`: **Added**
* `plex-api.library.getStreamLoudness()`: **Added**
* `plex-api.library.getChapterImage()`: **Added**
* `plex-api.library.setItemArtwork()`: **Added**
* `plex-api.library.updateItemArtwork()`: **Added**
* `plex-api.library.deleteMarker()`: **Added**
* `plex-api.library.editMarker()`: **Added**
* `plex-api.library.deleteMediaItem()`: **Added**
* `plex-api.library.getPartIndex()`: **Added**
* `plex-api.library.deleteCollection()`: **Added**
* `plex-api.library.getSectionImage()`: **Added**
* `plex-api.library.deleteStream()`: **Added**
* `plex-api.library.getStream()`: **Added**
* `plex-api.library.setStreamOffset()`: **Added**
* `plex-api.library.getItemArtwork()`: **Added**
* `plex-api.library.getMediaPart()`: **Added**
* `plex-api.library.getImageFromBif()`: **Added**
* `plex-api.collections.createCollection()`: **Added**
* `plex-api.dvRs.listDvRs()`: **Added**
* `plex-api.dvRs.createDvr()`: **Added**
* `plex-api.dvRs.deleteDvr()`: **Added**
* `plex-api.dvRs.getDvr()`: **Added**
* `plex-api.dvRs.deleteLineup()`: **Added**
* `plex-api.dvRs.addLineup()`: **Added**
* `plex-api.dvRs.setDvrPreferences()`: **Added**
* `plex-api.dvRs.stopDvrReload()`: **Added**
* `plex-api.dvRs.reloadGuide()`: **Added**
* `plex-api.dvRs.tuneChannel()`: **Added**
* `plex-api.dvRs.removeDeviceFromDvr()`: **Added**
* `plex-api.dvRs.addDeviceToDvr()`: **Added**
* `plex-api.epg.computeChannelMap()`: **Added**
* `plex-api.epg.getChannels()`: **Added**
* `plex-api.epg.getCountries()`: **Added**
* `plex-api.epg.getAllLanguages()`: **Added**
* `plex-api.epg.getLineup()`: **Added**
* `plex-api.epg.getLineupChannels()`: **Added**
* `plex-api.epg.getCountriesLineups()`: **Added**
* `plex-api.epg.getCountryRegions()`: **Added**
* `plex-api.epg.listLineups()`: **Added**
* `plex-api.liveTv.getSessions()`: **Added**
* `plex-api.liveTv.getLiveTvSession()`: **Added**
* `plex-api.liveTv.getSessionPlaylistIndex()`: **Added**
* `plex-api.liveTv.getSessionSegment()`: **Added**
* `plex-api.log.writeLog()`: **Added**
* `plex-api.log.writeMessage()`: **Added**
* `plex-api.log.enablePapertrail()`: **Added**
* `plex-api.devices.getAvailableGrabbers()`: **Added**
* `plex-api.devices.listDevices()`: **Added**
* `plex-api.devices.addDevice()`: **Added**
* `plex-api.devices.discoverDevices()`: **Added**
* `plex-api.devices.removeDevice()`: **Added**
* `plex-api.devices.getDeviceDetails()`: **Added**
* `plex-api.devices.modifyDevice()`: **Added**
* `plex-api.devices.setChannelmap()`: **Added**
* `plex-api.devices.getDevicesChannels()`: **Added**
* `plex-api.devices.setDevicePreferences()`: **Added**
* `plex-api.devices.stopScan()`: **Added**
* `plex-api.devices.scan()`: **Added**
* `plex-api.devices.getThumb()`: **Added**
* `plex-api.provider.listProviders()`: **Added**
* `plex-api.provider.addProvider()`: **Added**
* `plex-api.provider.refreshProviders()`: **Added**
* `plex-api.provider.deleteMediaProvider()`: **Added**
* `plex-api.subscriptions.getAllSubscriptions()`: **Added**
* `plex-api.subscriptions.createSubscription()`: **Added**
* `plex-api.subscriptions.processSubscriptions()`: **Added**
* `plex-api.subscriptions.getScheduledRecordings()`: **Added**
* `plex-api.subscriptions.getTemplate()`: **Added**
* `plex-api.subscriptions.cancelGrab()`: **Added**
* `plex-api.subscriptions.deleteSubscription()`: **Added**
* `plex-api.subscriptions.getSubscription()`: **Added**
* `plex-api.subscriptions.editSubscriptionPreferences()`: **Added**
* `plex-api.subscriptions.reorderSubscription()`: **Added**
* `plex-api.transcoder.transcodeImage()`: **Added**
* `plex-api.transcoder.makeDecision()`: **Added**
* `plex-api.transcoder.triggerFallback()`: **Added**
* `plex-api.transcoder.transcodeSubtitles()`: **Added**
* `plex-api.transcoder.startTranscodeSession()`: **Added**
* `plex-api.playlist.listPlaylists()`: **Added**
* `plex-api.playlist.getPlaylist()`: **Added**
* `plex-api.playlist.getPlaylistItems()`: **Added**
* `plex-api.libraryPlaylists.createPlaylist()`: **Added**
* `plex-api.libraryPlaylists.uploadPlaylist()`: **Added**
* `plex-api.libraryPlaylists.deletePlaylist()`: **Added**
* `plex-api.libraryPlaylists.updatePlaylist()`: **Added**
* `plex-api.libraryPlaylists.getPlaylistGenerators()`: **Added**
* `plex-api.libraryPlaylists.clearPlaylistItems()`: **Added**
* `plex-api.libraryPlaylists.addPlaylistItems()`: **Added**
* `plex-api.libraryPlaylists.deletePlaylistItem()`: **Added**
* `plex-api.libraryPlaylists.getPlaylistGenerator()`: **Added**
* `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`: **Added**
* `plex-api.libraryPlaylists.movePlaylistItem()`: **Added**
* `plex-api.libraryPlaylists.refreshPlaylist()`: **Added**
* `plex-api.playQueue.createPlayQueue()`: **Added**
* `plex-api.playQueue.getPlayQueue()`: **Added**
* `plex-api.playQueue.addToPlayQueue()`: **Added**
* `plex-api.playQueue.clearPlayQueue()`: **Added**
* `plex-api.playQueue.resetPlayQueue()`: **Added**
* `plex-api.playQueue.shuffle()`: **Added**
* `plex-api.playQueue.unshuffle()`: **Added**
* `plex-api.playQueue.deletePlayQueueItem()`: **Added**
* `plex-api.playQueue.movePlayQueueItem()`: **Added**
* `plex-api.ultraBlur.getColors()`: **Added**
* `plex-api.ultraBlur.getImage()`: **Added**
* `plex-api.status.listSessions()`: **Added**
* `plex-api.status.getBackgroundTasks()`: **Added**
* `plex-api.status.listPlaybackHistory()`: **Added**
* `plex-api.status.terminateSession()`: **Added**
* `plex-api.status.deleteHistory()`: **Added**
* `plex-api.status.getHistoryItem()`: **Added**
* `plex-api.updater.checkUpdates()`: **Added**
* `plex-api.updater.getUpdatesStatus()`: **Added**
* `plex-api.content.getCollectionItems()`: **Added**
* `plex-api.content.getMetadataItem()`: **Added**
* `plex-api.content.getAlbums()`: **Added**
* `plex-api.content.listContent()`: **Added**
* `plex-api.content.getAllLeaves()`: **Added**
* `plex-api.content.getArts()`: **Added**
* `plex-api.content.getCategories()`: **Added**
* `plex-api.content.getCluster()`: **Added**
* `plex-api.content.getSonicPath()`: **Added**
* `plex-api.content.getFolders()`: **Added**
* `plex-api.content.listMoments()`: **Added**
* `plex-api.content.getSonicallySimilar()`: **Added**
* `plex-api.content.getCollectionImage()`: **Added**
* `plex-api.libraryCollections.addCollectionItems()`: **Added**
* `plex-api.libraryCollections.deleteCollectionItem()`: **Added**
* `plex-api.libraryCollections.moveCollectionItem()`: **Added**
* `plex-api.server.getServerCapabilities()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getServerPreferences()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getAvailableClients()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getDevices()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getServerIdentity()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getMyPlexAccount()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getResizedPhoto()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getMediaProviders()`: **Deleted** **Breaking** ⚠️
* `plex-api.server.getServerList()`: **Deleted** **Breaking** ⚠️
* `plex-api.media.markPlayed()`: **Deleted** **Breaking** ⚠️
* `plex-api.media.markUnplayed()`: **Deleted** **Breaking** ⚠️
* `plex-api.media.updatePlayProgress()`: **Deleted** **Breaking** ⚠️
* `plex-api.media.getBannerImage()`: **Deleted** **Breaking** ⚠️
* `plex-api.media.getThumbImage()`: **Deleted** **Breaking** ⚠️
* `plex-api.video.getTimeline()`: **Deleted** **Breaking** ⚠️
* `plex-api.video.startUniversalTranscode()`: **Deleted** **Breaking** ⚠️
* `plex-api.activities.getServerActivities()`: **Deleted** **Breaking** ⚠️
* `plex-api.activities.cancelServerActivities()`: **Deleted** **Breaking** ⚠️
* `plex-api.butler.getButlerTasks()`: **Deleted** **Breaking** ⚠️
* `plex-api.butler.startAllTasks()`: **Deleted** **Breaking** ⚠️
* `plex-api.butler.stopAllTasks()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getCompanionsData()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getUserFriends()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getGeoData()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getHomeData()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getServerResources()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getPin()`: **Deleted** **Breaking** ⚠️
* `plex-api.plex.getTokenByPinId()`: **Deleted** **Breaking** ⚠️
* `plex-api.hubs.getGlobalHubs()`: **Deleted** **Breaking** ⚠️
* `plex-api.hubs.getRecentlyAdded()`: **Deleted** **Breaking** ⚠️
* `plex-api.hubs.getLibraryHubs()`: **Deleted** **Breaking** ⚠️
* `plex-api.search.performSearch()`: **Deleted** **Breaking** ⚠️
* `plex-api.search.performVoiceSearch()`: **Deleted** **Breaking** ⚠️
* `plex-api.search.getSearchResults()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getFileHash()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getRecentlyAddedLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getAllLibraries()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getLibraryDetails()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.deleteLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getLibraryItems()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getLibrarySectionsAll()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getRefreshLibraryMetadata()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getSearchLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getGenresLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getCountriesLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getActorsLibrary()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getSearchAllLibraries()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getMediaMetaData()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getMediaArts()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.postMediaArts()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getMediaPosters()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.postMediaPoster()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getMetadataChildren()`: **Deleted** **Breaking** ⚠️
* `plex-api.library.getTopWatchedContent()`: **Deleted** **Breaking** ⚠️
* `plex-api.watchlist.getWatchList()`: **Deleted** **Breaking** ⚠️
* `plex-api.log.logLine()`: **Deleted** **Breaking** ⚠️
* `plex-api.log.logMultiLine()`: **Deleted** **Breaking** ⚠️
* `plex-api.log.enablePaperTrail()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.createPlaylist()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.getPlaylists()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.getPlaylist()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.deletePlaylist()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.updatePlaylist()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.getPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.clearPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.addPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `plex-api.playlists.uploadPlaylist()`: **Deleted** **Breaking** ⚠️
* `plex-api.authentication.getTransientToken()`: **Deleted** **Breaking** ⚠️
* `plex-api.authentication.getSourceConnectionInformation()`: **Deleted** **Breaking** ⚠️
* `plex-api.authentication.getTokenDetails()`: **Deleted** **Breaking** ⚠️
* `plex-api.authentication.postUsersSignInData()`: **Deleted** **Breaking** ⚠️
* `plex-api.statistics.getStatistics()`: **Deleted** **Breaking** ⚠️
* `plex-api.statistics.getResourcesStatistics()`: **Deleted** **Breaking** ⚠️
* `plex-api.statistics.getBandwidthStatistics()`: **Deleted** **Breaking** ⚠️
* `plex-api.sessions.getSessions()`: **Deleted** **Breaking** ⚠️
* `plex-api.sessions.getSessionHistory()`: **Deleted** **Breaking** ⚠️
* `plex-api.sessions.getTranscodeSessions()`: **Deleted** **Breaking** ⚠️
* `plex-api.sessions.stopTranscodeSession()`: **Deleted** **Breaking** ⚠️
* `plex-api.updater.getUpdateStatus()`: **Deleted** **Breaking** ⚠️
* `plex-api.updater.checkForUpdates()`: **Deleted** **Breaking** ⚠️
* `plex-api.users.getUsers()`: **Deleted** **Breaking** ⚠️
2025-10-12 06:53:30 +00:00
Luke Hagar
c7a69e0673 Update workflow.yaml 2025-10-12 01:48:50 -05:00
speakeasybot
820f55d192 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.615.2 2025-09-16 00:29:53 +00:00
speakeasybot
aa85c1813b ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.557.0 2025-06-09 00:34:24 +00:00
speakeasybot
84fb18428a ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.555.2 2025-06-04 00:32:38 +00:00
speakeasybot
37569715a6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.542.1 2025-05-05 00:33:15 +00:00
speakeasybot
c0e915da8b ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.541.2 2025-05-01 00:34:27 +00:00
speakeasybot
0077561a6a ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.535.1 2025-04-19 00:29:11 +00:00
speakeasybot
4b28ca3416 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4 2025-04-14 00:32:09 +00:00
speakeasybot
dd781d1e27 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1 2025-04-06 00:31:55 +00:00
speakeasybot
dcdcafc044 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.528.1 2025-04-03 00:29:22 +00:00
speakeasybot
04db2979db ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 17:09:11 +00:00
Luke Hagar
c2eeb488c4 Update workflow.yaml 2025-03-31 12:05:52 -05:00
speakeasybot
8194abfa99 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4 2025-03-09 00:26:13 +00:00
speakeasybot
26e1ac258e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.2 2025-03-07 00:28:59 +00:00
speakeasybot
bf77d1e2b9 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1 2025-02-10 00:28:48 +00:00
speakeasybot
3523b6a0c8 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0 2025-02-07 00:27:46 +00:00
speakeasybot
a4a2130978 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-06 00:27:45 +00:00
speakeasybot
f33408b177 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-05 00:27:30 +00:00
speakeasybot
22654201f5 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.476.1 2025-01-27 00:28:08 +00:00
speakeasybot
9dc8821b31 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0 2025-01-24 00:27:12 +00:00
speakeasybot
412b27f162 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-22 00:30:11 +00:00
speakeasybot
9c8fe4c95e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-21 00:27:05 +00:00
speakeasybot
a60df4029d ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.439.0 2024-11-14 00:27:10 +00:00
speakeasybot
99af1ce0f6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.438.1 2024-11-12 00:26:38 +00:00
speakeasybot
025b6c4640 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-04 00:27:05 +00:00
speakeasybot
2e4350c8c4 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 00:28:29 +00:00
speakeasybot
fa542f04e1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 00:30:18 +00:00
speakeasybot
64bc159be2 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5 2024-09-30 00:28:31 +00:00
speakeasybot
8100bcbf96 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5 2024-09-29 00:30:08 +00:00
speakeasybot
10a61122c2 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5 2024-09-28 00:26:45 +00:00
speakeasybot
fbca010d26 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.402.14 2024-09-26 00:26:45 +00:00
speakeasybot
beae244178 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2 2024-09-22 00:29:24 +00:00
speakeasybot
3499fe6d12 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2 2024-09-21 00:25:44 +00:00
speakeasybot
f3780ae807 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.399.2 2024-09-19 00:26:57 +00:00
speakeasybot
ce09c0c9f6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.3 2024-09-16 19:34:43 +00:00
Luke Hagar
d17be8f8fa secret names 2024-09-16 19:31:20 +00:00
Luke Hagar
2e07625687 secret names 2024-09-16 19:29:49 +00:00
speakeasybot
258203517f ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.3 2024-09-16 19:16:31 +00:00
Luke Hagar
af70af8aee username as var 2024-09-16 19:12:57 +00:00
Luke Hagar
ee80753a6b Added username 2024-09-16 19:12:05 +00:00
speakeasybot
0bcb23bc24 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2 2024-09-16 18:57:10 +00:00
Luke Hagar
bb34cb3d87 Removed extra file 2024-09-16 18:53:32 +00:00
speakeasybot
fe1cd8c7e4 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2 2024-09-16 18:34:13 +00:00
Luke Hagar
9b00b9305f Update gen.yaml 2024-09-16 13:31:58 -05:00
speakeasybot
de40bbb5d9 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2 2024-09-16 18:24:27 +00:00
Luke Hagar
2c1cfa8b8d Update workflow.yaml 2024-09-16 13:15:07 -05:00
speakeasybot
5585a18ab9 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.396.6 2024-09-13 00:25:35 +00:00
Luke Hagar
f83d7949e1 swapped to direct 2024-09-08 02:48:59 +00:00
Luke Hagar
ac816582a6 updated publishing 2024-09-08 02:47:27 +00:00
Luke Hagar
ac5716c20d regerated and working on publishing 2024-09-08 02:40:34 +00:00
Luke Hagar
02ce124a6b Clean up README.md 2024-07-01 16:03:44 +00:00
Luke Hagar
42b3e684dd Fresh generation 2024-07-01 16:03:10 +00:00
Luke Hagar
e01292f115 nuking repo 2024-07-01 16:02:39 +00:00
Luke Hagar
791c875755 Merge branch 'main' of https://github.com/LukeHagar/plexjava 2024-07-01 16:02:07 +00:00
Luke Hagar
981d3b0315 Regenerated with a mostly empty directory 2024-07-01 16:00:34 +00:00
speakeasy-bot
fe0550bbf2 Update push code samples in generation action 2024-07-01 15:42:32 +00:00
speakeasy-bot
aa9000664f Create speakeasy tagging action workflow 2024-07-01 15:42:31 +00:00
speakeasy-bot
6bbcb8fd0f Add code samples registry configuration 2024-07-01 15:42:27 +00:00
Luke Hagar
1be6dc2bfd Regenerated SDK 2024-06-27 16:48:57 +00:00
Luke Hagar
3ae54cf9c3 Generating SDK locally, migrated action to v15 2024-03-18 14:18:45 -07:00
Luke Hagar
207d81ed46 Update gen.yaml 2024-03-12 10:05:37 -05:00
Luke Hagar
30b4b97ccd Update speakeasy_sdk_generation.yml 2024-03-12 09:59:31 -05:00
Luke Hagar
78e6a90951 Update speakeasy_sdk_generation.yml 2024-03-12 09:57:09 -05:00
speakeasy-bot
c2e5abe96a 🐝 Add license. 2024-02-23 15:37:38 +00:00
speakeasy-bot
f428a04174 🐝 Update gen.yaml 2024-02-23 15:37:38 +00:00
speakeasy-bot
fbb10b5a67 🐝 Update workflow file 2024-02-23 15:37:37 +00:00
speakeasy-bot
c46abb8b2b 🐝 Add license. 2024-02-01 16:30:27 +00:00
speakeasy-bot
330c0f6f59 🐝 Update gen.yaml 2024-02-01 16:30:27 +00:00
speakeasy-bot
245b8f4ee9 🐝 Update workflow file 2024-02-01 16:30:26 +00:00
speakeasy-bot
364e5a1448 🐝 Add license. 2024-01-05 19:36:52 +00:00
speakeasy-bot
ea21a808c6 🐝 Update gen.yaml 2024-01-05 19:36:51 +00:00
speakeasy-bot
49e9caf871 🐝 Update workflow file 2024-01-05 19:36:50 +00:00
speakeasy-bot
9d2de813ba 🐝 Add license. 2024-01-01 15:09:19 +00:00
speakeasy-bot
360c0d1336 🐝 Update gen.yaml 2024-01-01 15:09:18 +00:00
speakeasy-bot
8500f7ef80 🐝 Update workflow file 2024-01-01 15:09:18 +00:00
speakeasy-bot
e04c5b3f06 🐝 Add license. 2024-01-01 14:36:31 +00:00
speakeasy-bot
d766b3cc4e 🐝 Update gen.yaml 2024-01-01 14:36:31 +00:00
speakeasy-bot
66ee7fb1ab 🐝 Update workflow file 2024-01-01 14:36:30 +00:00
speakeasy-bot
8420084171 🐝 Add license. 2023-12-24 05:08:26 +00:00
speakeasy-bot
12f0a76bfe 🐝 Update workflow file 2023-12-24 05:08:25 +00:00
speakeasy-bot
366f2fbf89 🐝 Write repo Makefile 2023-12-24 05:08:24 +00:00
2898 changed files with 578090 additions and 25685 deletions

View File

@@ -1,22 +0,0 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/java
{
"name": "Java SDK",
"image": "mcr.microsoft.com/devcontainers/java:1-17-bullseye",
"features": {
"ghcr.io/devcontainers/features/java:1": {
"version": "none",
"installMaven": "true",
"installGradle": "false"
}
},
"postCreateCommand": "mvn install && mvn -f examples/pom.xml install",
"customizations": {
"codespaces": {
"openFiles": [
"examples/src/main/java/47/one0/examples/Main.java",
"README.md"
]
}
}
}

View File

@@ -1,2 +0,0 @@
PLEXSDK_API_KEY=
PLEXSDK_API_KEY_HEADER=

11
.gitattributes vendored Normal file
View File

@@ -0,0 +1,11 @@
#
# https://help.github.com/articles/dealing-with-line-endings/
#
# Linux start script should use lf
/gradlew text eol=lf
# These are Windows script files and should use crlf
*.bat text eol=crlf
# This allows generated code to be indexed correctly
*.java linguist-generated=false

View File

@@ -1,23 +0,0 @@
# This workflow was added by CodeSee. Learn more at https://codesee.io/
# This is v2.0 of this workflow file
on:
push:
branches:
- main
pull_request_target:
types: [opened, synchronize, reopened]
name: CodeSee
permissions: read-all
jobs:
codesee:
runs-on: ubuntu-latest
continue-on-error: true
name: Analyze the repo with CodeSee
steps:
- uses: Codesee-io/codesee-action@v2
with:
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
codesee-url: https://app.codesee.io

33
.github/workflows/sdk_generation.yaml vendored Normal file
View File

@@ -0,0 +1,33 @@
name: Generate
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
"on":
workflow_dispatch:
inputs:
force:
description: Force generation of SDKs
type: boolean
default: false
set_version:
description: optionally set a specific SDK version
type: string
schedule:
- cron: 0 0 * * *
jobs:
generate:
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
with:
force: ${{ github.event.inputs.force }}
mode: direct
set_version: ${{ github.event.inputs.set_version }}
speakeasy_version: latest
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
java_gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
java_gpg_secret_key: ${{ secrets.GPG_SECRET_KEY }}
ossrh_username: ${{ secrets.OSSRH_USERNAME }}
ossrh_password: ${{ secrets.OSSRH_PASSWORD }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

22
.github/workflows/sdk_publish.yaml vendored Normal file
View File

@@ -0,0 +1,22 @@
name: Publish
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
"on":
push:
branches:
- main
paths:
- RELEASES.md
- '*/RELEASES.md'
jobs:
publish:
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
java_gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
java_gpg_secret_key: ${{ secrets.GPG_SECRET_KEY }}
ossrh_password: ${{ secrets.OSSRH_PASSWORD }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

38
.gitignore vendored
View File

@@ -1,24 +1,14 @@
# Compiled class file
*.class
# Log file
*.log
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
replay_pid*
.env
.env.local
**/.speakeasy/temp/
**/.speakeasy/logs/
.speakeasy/reports
# Ignore Gradle project-specific cache directory
.gradle
# Ignore Gradle build output directory
build
bin/
# Ignore IDE-specific configs
.project
.settings/
.DS_Store

8402
.speakeasy/gen.lock Executable file

File diff suppressed because one or more lines are too long

61
.speakeasy/gen.yaml Normal file
View File

@@ -0,0 +1,61 @@
configVersion: 2.0.0
generation:
sdkClassName: Plex-API
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
nameResolutionFeb2025: false
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
hoistGlobalSecurity: true
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
java:
version: 0.20.1
additionalDependencies: []
additionalPlugins: []
artifactID: plexapi
asyncMode: enabled
baseErrorName: PlexAPIError
clientServerStatusCodesAsErrors: true
companyEmail: lukeslakemail@gmail.com
companyName: plexapi
companyURL: plexapi.dev
defaultErrorName: SDKError
enableCustomCodeRegions: false
enableStreamingUploads: false
flattenGlobalSecurity: true
generateSpringBootStarter: true
githubURL: github.com/LukeHagar/plexjava
groupID: dev.plexapi
imports:
option: openapi
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models/shared
webhooks: models/webhooks
inputModelSuffix: input
languageVersion: 11
license:
name: The MIT License (MIT)
shortName: MIT
url: https://mit-license.org/
maxMethodParams: 4
nullFriendlyParameters: false
outputModelSuffix: output
packageName: dev.plexapi.sdk
projectName: plexapi
templateVersion: v2

49
.speakeasy/workflow.lock Normal file
View File

@@ -0,0 +1,49 @@
speakeasyVersion: 1.615.2
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:893baf00932f1b8e49b2e60af272be6a9a62934af6eb3a2f96dd9f2302ef69c5
sourceBlobDigest: sha256:f689cdc9c740f4e5120422720722d2d256d56ceb62bc13370713ec1661a433df
tags:
- latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
tags:
- latest
- speakeasy-sdk-regen-1760315484
- 1.1.1
targets:
plexjava:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:0e9f7ca03e6a970d7b77654ab41d0a1605f0105871db2630a7afc85d4362b624
sourceBlobDigest: sha256:c0a6079f21e9d8cf8b3a205d2da333b78b2cb7e0db9dd895a41c68c2580e2d64
codeSamplesNamespace: code-samples-java-plexjava
codeSamplesRevisionDigest: sha256:e076772184b6e43037b79abcef938bd0dd86905117a8634a7ed733736455b55e
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
plexapi:
inputs:
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets:
plexjava:
target: java
source: plexapi
publish:
java:
ossrhUsername: $ossrh_username
ossrhPassword: $ossrh_password
gpgSecretKey: $java_gpg_secret_key
gpgPassPhrase: $java_gpg_passphrase
codeSamples:
output: codeSamples.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
labelOverride:
fixedValue: PlexJava

24
.speakeasy/workflow.yaml Normal file
View File

@@ -0,0 +1,24 @@
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
plexapi:
inputs:
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/plex-api-spec.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets:
plexjava:
target: java
source: plexapi
publish:
java:
ossrhUsername: $ossrh_username
ossrhPassword: $ossrh_password
gpgSecretKey: $java_gpg_secret_key
gpgPassPhrase: $java_gpg_passphrase
codeSamples:
output: codeSamples.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
labelOverride:
fixedValue: PlexJava

26
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,26 @@
# Contributing to This Repository
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
## How to Report Issues
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
## Issue Triage and Upstream Fixes
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
## Contact
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
Thank you for your understanding and cooperation!
The Maintainers

19
LICENSE
View File

@@ -1,19 +0,0 @@
Copyright (c) 2023
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.

926
README.md
View File

@@ -1,132 +1,870 @@
# plexapi
<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://mit-license.org/">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
# PlexSDK Java SDK 0.0.1
A Java SDK for PlexSDK.
<!-- Start Summary [summary] -->
## Summary
An Open API Spec for interacting with Plex.tv and Plex Servers
- API version: 0.0.1
- SDK version: 0.0.1
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Authentication](#authentication)
- [API Key](#api-key)
- [API Endpoint Services](#api-endpoint-services)
- [API Models](#api-models)
- [Testing](#testing)
- [Configuration](#configuration)
- [Sample Usage](#sample-usage)
- [License](#license)
<!-- $toc-max-depth=2 -->
* [plexapi](#plexapi)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Asynchronous Support](#asynchronous-support)
* [Authentication](#authentication)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## Requirements
<!-- End Table of Contents [toc] -->
- Java 8
- Maven
<!-- Start SDK Installation [installation] -->
## SDK Installation
## Installation
### Getting started
If you use Maven, place the following within the <dependencies> tag in your pom.xml file:
JDK 11 or later is required.
```XML
The samples below show how a published SDK artifact is used:
Gradle:
```groovy
implementation 'dev.plexapi:plexapi:0.20.1'
```
Maven:
```xml
<dependency>
<groupId>47.one0</groupId>
<artifactId>plex-sdk</artifactId>
<version>0.0.1</version>
<groupId>dev.plexapi</groupId>
<artifactId>plexapi</artifactId>
<version>0.20.1</version>
</dependency>
```
If you use Gradle, paste the next line inside the dependencies block of your build.gradle file:
### How to build
After cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.
```Gradle
implementation group: "47.one0", name: "PlexSDK", version: "0.0.1"
If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):
On *nix:
```bash
./gradlew publishToMavenLocal -Pskip.signing
```
On Windows:
```bash
gradlew.bat publishToMavenLocal -Pskip.signing
```
<!-- End SDK Installation [installation] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
StartTranscodeSessionRequest req = StartTranscodeSessionRequest.builder()
.transcodeType(TranscodeType.MUSIC)
.extension(Extension.MPD)
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.location(StartTranscodeSessionQueryParamLocation.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)
.musicBitrate(5000L)
.offset(90.5)
.partIndex(0L)
.path("/library/metadata/151671")
.peakBitrate(12000L)
.photoResolution("1080x1080")
.protocol(StartTranscodeSessionQueryParamProtocol.DASH)
.secondsPerSegment(5L)
.subtitleSize(50L)
.videoBitrate(12000L)
.videoQuality(50L)
.videoResolution("1080x1080")
.xPlexClientProfileExtra("add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)")
.xPlexClientProfileName("generic")
.build();
StartTranscodeSessionResponse res = sdk.transcoder().startTranscodeSession()
.request(req)
.call();
if (res.responseStream().isPresent()) {
// handle response
}
}
}
```
#### Asynchronous Call
An asynchronous SDK client is also available that returns a [`CompletableFuture<T>`][comp-fut]. See [Asynchronous Support](#asynchronous-support) for more details on async benefits and reactive library integration.
```java
package hello.world;
import dev.plexapi.sdk.AsyncPlexAPI;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
import dev.plexapi.sdk.models.operations.async.GetServerInfoResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.util.concurrent.CompletableFuture;
public class Application {
public static void main(String[] args) {
AsyncPlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build()
.async();
GetServerInfoRequest req = GetServerInfoRequest.builder()
.build();
CompletableFuture<GetServerInfoResponse> resFut = sdk.general().getServerInfo()
.request(req)
.call();
resFut.thenAccept(res -> {
if (res.mediaContainerWithDirectory().isPresent()) {
// handle response
}
});
}
}
```
[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [activities()](docs/sdks/activities/README.md)
* [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities
* [cancelActivity](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
### [butler()](docs/sdks/butler/README.md)
* [stopTasks](docs/sdks/butler/README.md#stoptasks) - Stop all Butler tasks
* [getTasks](docs/sdks/butler/README.md#gettasks) - Get all Butler tasks
* [startTasks](docs/sdks/butler/README.md#starttasks) - Start all Butler tasks
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
### [collections()](docs/sdks/collections/README.md)
* [createCollection](docs/sdks/collections/README.md#createcollection) - Create collection
### [content()](docs/sdks/content/README.md)
* [getCollectionItems](docs/sdks/content/README.md#getcollectionitems) - Get items in a collection
* [getMetadataItem](docs/sdks/content/README.md#getmetadataitem) - Get a metadata item
* [getAlbums](docs/sdks/content/README.md#getalbums) - Set section albums
* [listContent](docs/sdks/content/README.md#listcontent) - Get items in the section
* [getAllLeaves](docs/sdks/content/README.md#getallleaves) - Set section leaves
* [getArts](docs/sdks/content/README.md#getarts) - Set section artwork
* [getCategories](docs/sdks/content/README.md#getcategories) - Set section categories
* [getCluster](docs/sdks/content/README.md#getcluster) - Set section clusters
* [getSonicPath](docs/sdks/content/README.md#getsonicpath) - Similar tracks to transition from one to another
* [getFolders](docs/sdks/content/README.md#getfolders) - Get all folder locations
* [listMoments](docs/sdks/content/README.md#listmoments) - Set section moments
* [getSonicallySimilar](docs/sdks/content/README.md#getsonicallysimilar) - The nearest audio tracks
* [getCollectionImage](docs/sdks/content/README.md#getcollectionimage) - Get a collection's image
### [devices()](docs/sdks/devices/README.md)
* [getAvailableGrabbers](docs/sdks/devices/README.md#getavailablegrabbers) - Get available grabbers
* [listDevices](docs/sdks/devices/README.md#listdevices) - Get all devices
* [addDevice](docs/sdks/devices/README.md#adddevice) - Add a device
* [discoverDevices](docs/sdks/devices/README.md#discoverdevices) - Tell grabbers to discover devices
* [removeDevice](docs/sdks/devices/README.md#removedevice) - Remove a device
* [getDeviceDetails](docs/sdks/devices/README.md#getdevicedetails) - Get device details
* [modifyDevice](docs/sdks/devices/README.md#modifydevice) - Enable or disable a device
* [setChannelmap](docs/sdks/devices/README.md#setchannelmap) - Set a device's channel mapping
* [getDevicesChannels](docs/sdks/devices/README.md#getdeviceschannels) - Get a device's channels
* [setDevicePreferences](docs/sdks/devices/README.md#setdevicepreferences) - Set device preferences
* [stopScan](docs/sdks/devices/README.md#stopscan) - Tell a device to stop scanning for channels
* [scan](docs/sdks/devices/README.md#scan) - Tell a device to scan for channels
* [getThumb](docs/sdks/devices/README.md#getthumb) - Get device thumb
### [downloadQueue()](docs/sdks/downloadqueue/README.md)
* [createDownloadQueue](docs/sdks/downloadqueue/README.md#createdownloadqueue) - Create download queue
* [getDownloadQueue](docs/sdks/downloadqueue/README.md#getdownloadqueue) - Get a download queue
* [addDownloadQueueItems](docs/sdks/downloadqueue/README.md#adddownloadqueueitems) - Add to download queue
* [listDownloadQueueItems](docs/sdks/downloadqueue/README.md#listdownloadqueueitems) - Get download queue items
* [getItemDecision](docs/sdks/downloadqueue/README.md#getitemdecision) - Grab download queue item decision
* [getDownloadQueueMedia](docs/sdks/downloadqueue/README.md#getdownloadqueuemedia) - Grab download queue media
* [removeDownloadQueueItems](docs/sdks/downloadqueue/README.md#removedownloadqueueitems) - Delete download queue items
* [getDownloadQueueItems](docs/sdks/downloadqueue/README.md#getdownloadqueueitems) - Get download queue items
* [restartProcessingDownloadQueueItems](docs/sdks/downloadqueue/README.md#restartprocessingdownloadqueueitems) - Restart processing of items from the decision
### [dvRs()](docs/sdks/dvrs/README.md)
* [listDVRs](docs/sdks/dvrs/README.md#listdvrs) - Get DVRs
* [createDVR](docs/sdks/dvrs/README.md#createdvr) - Create a DVR
* [deleteDVR](docs/sdks/dvrs/README.md#deletedvr) - Delete a single DVR
* [getDVR](docs/sdks/dvrs/README.md#getdvr) - Get a single DVR
* [deleteLineup](docs/sdks/dvrs/README.md#deletelineup) - Delete a DVR Lineup
* [addLineup](docs/sdks/dvrs/README.md#addlineup) - Add a DVR Lineup
* [setDVRPreferences](docs/sdks/dvrs/README.md#setdvrpreferences) - Set DVR preferences
* [stopDVRReload](docs/sdks/dvrs/README.md#stopdvrreload) - Tell a DVR to stop reloading program guide
* [reloadGuide](docs/sdks/dvrs/README.md#reloadguide) - Tell a DVR to reload program guide
* [tuneChannel](docs/sdks/dvrs/README.md#tunechannel) - Tune a channel on a DVR
* [removeDeviceFromDVR](docs/sdks/dvrs/README.md#removedevicefromdvr) - Remove a device from an existing DVR
* [addDeviceToDVR](docs/sdks/dvrs/README.md#adddevicetodvr) - Add a device to an existing DVR
### [epg()](docs/sdks/epg/README.md)
* [computeChannelMap](docs/sdks/epg/README.md#computechannelmap) - Compute the best channel map
* [getChannels](docs/sdks/epg/README.md#getchannels) - Get channels for a lineup
* [getCountries](docs/sdks/epg/README.md#getcountries) - Get all countries
* [getAllLanguages](docs/sdks/epg/README.md#getalllanguages) - Get all languages
* [getLineup](docs/sdks/epg/README.md#getlineup) - Compute the best lineup
* [getLineupChannels](docs/sdks/epg/README.md#getlineupchannels) - Get the channels for mulitple lineups
* [getCountriesLineups](docs/sdks/epg/README.md#getcountrieslineups) - Get lineups for a country via postal code
* [getCountryRegions](docs/sdks/epg/README.md#getcountryregions) - Get regions for a country
* [listLineups](docs/sdks/epg/README.md#listlineups) - Get lineups for a region
### [events()](docs/sdks/events/README.md)
* [getNotifications](docs/sdks/events/README.md#getnotifications) - Connect to Eventsource
* [connectWebSocket](docs/sdks/events/README.md#connectwebsocket) - Connect to WebSocket
### [general()](docs/sdks/general/README.md)
* [getServerInfo](docs/sdks/general/README.md#getserverinfo) - Get PMS info
* [getIdentity](docs/sdks/general/README.md#getidentity) - Get PMS identity
* [getSourceConnectionInformation](docs/sdks/general/README.md#getsourceconnectioninformation) - Get Source Connection Information
* [getTransientToken](docs/sdks/general/README.md#gettransienttoken) - Get Transient Tokens
### [hubs()](docs/sdks/hubs/README.md)
* [getAllHubs](docs/sdks/hubs/README.md#getallhubs) - Get global hubs
* [getContinueWatching](docs/sdks/hubs/README.md#getcontinuewatching) - Get the continue watching hub
* [getHubItems](docs/sdks/hubs/README.md#gethubitems) - Get a hub's items
* [getPromotedHubs](docs/sdks/hubs/README.md#getpromotedhubs) - Get the hubs which are promoted
* [getMetadataHubs](docs/sdks/hubs/README.md#getmetadatahubs) - Get hubs for section by metadata item
* [getPostplayHubs](docs/sdks/hubs/README.md#getpostplayhubs) - Get postplay hubs
* [getRelatedHubs](docs/sdks/hubs/README.md#getrelatedhubs) - Get related hubs
* [getSectionHubs](docs/sdks/hubs/README.md#getsectionhubs) - Get section hubs
* [resetSectionDefaults](docs/sdks/hubs/README.md#resetsectiondefaults) - Reset hubs to defaults
* [listHubs](docs/sdks/hubs/README.md#listhubs) - Get hubs
* [createCustomHub](docs/sdks/hubs/README.md#createcustomhub) - Create a custom hub
* [moveHub](docs/sdks/hubs/README.md#movehub) - Move Hub
* [deleteCustomHub](docs/sdks/hubs/README.md#deletecustomhub) - Delete a custom hub
* [updateHubVisibility](docs/sdks/hubs/README.md#updatehubvisibility) - Change hub visibility
### [library()](docs/sdks/library/README.md)
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get all items in library
* [deleteCaches](docs/sdks/library/README.md#deletecaches) - Delete library caches
* [cleanBundles](docs/sdks/library/README.md#cleanbundles) - Clean bundles
* [ingestTransientItem](docs/sdks/library/README.md#ingesttransientitem) - Ingest a transient item
* [getLibraryMatches](docs/sdks/library/README.md#getlibrarymatches) - Get library matches
* [optimizeDatabase](docs/sdks/library/README.md#optimizedatabase) - Optimize the Database
* [getRandomArtwork](docs/sdks/library/README.md#getrandomartwork) - Get random artwork
* [getSections](docs/sdks/library/README.md#getsections) - Get library sections (main Media Provider Only)
* [addSection](docs/sdks/library/README.md#addsection) - Add a library section
* [stopAllRefreshes](docs/sdks/library/README.md#stopallrefreshes) - Stop refresh
* [getSectionsPrefs](docs/sdks/library/README.md#getsectionsprefs) - Get section prefs
* [refreshSectionsMetadata](docs/sdks/library/README.md#refreshsectionsmetadata) - Refresh all sections
* [getTags](docs/sdks/library/README.md#gettags) - Get all library tags of a type
* [deleteMetadataItem](docs/sdks/library/README.md#deletemetadataitem) - Delete a metadata item
* [editMetadataItem](docs/sdks/library/README.md#editmetadataitem) - Edit a metadata item
* [detectAds](docs/sdks/library/README.md#detectads) - Ad-detect an item
* [getAllItemLeaves](docs/sdks/library/README.md#getallitemleaves) - Get the leaves of an item
* [analyzeMetadata](docs/sdks/library/README.md#analyzemetadata) - Analyze an item
* [generateThumbs](docs/sdks/library/README.md#generatethumbs) - Generate thumbs of chapters for an item
* [detectCredits](docs/sdks/library/README.md#detectcredits) - Credit detect a metadata item
* [getExtras](docs/sdks/library/README.md#getextras) - Get an item's extras
* [addExtras](docs/sdks/library/README.md#addextras) - Add to an item's extras
* [getFile](docs/sdks/library/README.md#getfile) - Get a file from a metadata or media bundle
* [startBifGeneration](docs/sdks/library/README.md#startbifgeneration) - Start BIF generation of an item
* [detectIntros](docs/sdks/library/README.md#detectintros) - Intro detect an item
* [createMarker](docs/sdks/library/README.md#createmarker) - Create a marker
* [matchItem](docs/sdks/library/README.md#matchitem) - Match a metadata item
* [listMatches](docs/sdks/library/README.md#listmatches) - Get metadata matches for an item
* [mergeItems](docs/sdks/library/README.md#mergeitems) - Merge a metadata item
* [listSonicallySimilar](docs/sdks/library/README.md#listsonicallysimilar) - Get nearest tracks to metadata item
* [setItemPreferences](docs/sdks/library/README.md#setitempreferences) - Set metadata preferences
* [refreshItemsMetadata](docs/sdks/library/README.md#refreshitemsmetadata) - Refresh a metadata item
* [getRelatedItems](docs/sdks/library/README.md#getrelateditems) - Get related items
* [listSimilar](docs/sdks/library/README.md#listsimilar) - Get similar items
* [splitItem](docs/sdks/library/README.md#splititem) - Split a metadata item
* [addSubtitles](docs/sdks/library/README.md#addsubtitles) - Add subtitles
* [getItemTree](docs/sdks/library/README.md#getitemtree) - Get metadata items as a tree
* [unmatch](docs/sdks/library/README.md#unmatch) - Unmatch a metadata item
* [listTopUsers](docs/sdks/library/README.md#listtopusers) - Get metadata top users
* [detectVoiceActivity](docs/sdks/library/README.md#detectvoiceactivity) - Detect voice activity
* [getAugmentationStatus](docs/sdks/library/README.md#getaugmentationstatus) - Get augmentation status
* [setStreamSelection](docs/sdks/library/README.md#setstreamselection) - Set stream selection
* [getPerson](docs/sdks/library/README.md#getperson) - Get person details
* [listPersonMedia](docs/sdks/library/README.md#listpersonmedia) - Get media for a person
* [deleteLibrarySection](docs/sdks/library/README.md#deletelibrarysection) - Delete a library section
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get a library section by id
* [editSection](docs/sdks/library/README.md#editsection) - Edit a library section
* [updateItems](docs/sdks/library/README.md#updateitems) - Set the fields of the filtered items
* [startAnalysis](docs/sdks/library/README.md#startanalysis) - Analyze a section
* [autocomplete](docs/sdks/library/README.md#autocomplete) - Get autocompletions for search
* [getCollections](docs/sdks/library/README.md#getcollections) - Get collections in a section
* [getCommon](docs/sdks/library/README.md#getcommon) - Get common fields for items
* [emptyTrash](docs/sdks/library/README.md#emptytrash) - Empty section trash
* [getSectionFilters](docs/sdks/library/README.md#getsectionfilters) - Get section filters
* [getFirstCharacters](docs/sdks/library/README.md#getfirstcharacters) - Get list of first characters
* [deleteIndexes](docs/sdks/library/README.md#deleteindexes) - Delete section indexes
* [deleteIntros](docs/sdks/library/README.md#deleteintros) - Delete section intro markers
* [getSectionPreferences](docs/sdks/library/README.md#getsectionpreferences) - Get section prefs
* [setSectionPreferences](docs/sdks/library/README.md#setsectionpreferences) - Set section prefs
* [cancelRefresh](docs/sdks/library/README.md#cancelrefresh) - Cancel section refresh
* [refreshSection](docs/sdks/library/README.md#refreshsection) - Refresh section
* [getAvailableSorts](docs/sdks/library/README.md#getavailablesorts) - Get a section sorts
* [getStreamLevels](docs/sdks/library/README.md#getstreamlevels) - Get loudness about a stream in json
* [getStreamLoudness](docs/sdks/library/README.md#getstreamloudness) - Get loudness about a stream
* [getChapterImage](docs/sdks/library/README.md#getchapterimage) - Get a chapter image
* [setItemArtwork](docs/sdks/library/README.md#setitemartwork) - Set an item's artwork, theme, etc
* [updateItemArtwork](docs/sdks/library/README.md#updateitemartwork) - Set an item's artwork, theme, etc
* [deleteMarker](docs/sdks/library/README.md#deletemarker) - Delete a marker
* [editMarker](docs/sdks/library/README.md#editmarker) - Edit a marker
* [deleteMediaItem](docs/sdks/library/README.md#deletemediaitem) - Delete a media item
* [getPartIndex](docs/sdks/library/README.md#getpartindex) - Get BIF index for a part
* [deleteCollection](docs/sdks/library/README.md#deletecollection) - Delete a collection
* [getSectionImage](docs/sdks/library/README.md#getsectionimage) - Get a section composite image
* [deleteStream](docs/sdks/library/README.md#deletestream) - Delete a stream
* [getStream](docs/sdks/library/README.md#getstream) - Get a stream
* [setStreamOffset](docs/sdks/library/README.md#setstreamoffset) - Set a stream offset
* [getItemArtwork](docs/sdks/library/README.md#getitemartwork) - Get an item's artwork, theme, etc
* [getMediaPart](docs/sdks/library/README.md#getmediapart) - Get a media part
* [getImageFromBif](docs/sdks/library/README.md#getimagefrombif) - Get an image from part BIF
### [libraryCollections()](docs/sdks/librarycollections/README.md)
* [addCollectionItems](docs/sdks/librarycollections/README.md#addcollectionitems) - Add items to a collection
* [deleteCollectionItem](docs/sdks/librarycollections/README.md#deletecollectionitem) - Delete an item from a collection
* [moveCollectionItem](docs/sdks/librarycollections/README.md#movecollectionitem) - Reorder an item in the collection
### [libraryPlaylists()](docs/sdks/libraryplaylists/README.md)
* [createPlaylist](docs/sdks/libraryplaylists/README.md#createplaylist) - Create a Playlist
* [uploadPlaylist](docs/sdks/libraryplaylists/README.md#uploadplaylist) - Upload
* [deletePlaylist](docs/sdks/libraryplaylists/README.md#deleteplaylist) - Delete a Playlist
* [updatePlaylist](docs/sdks/libraryplaylists/README.md#updateplaylist) - Editing a Playlist
* [getPlaylistGenerators](docs/sdks/libraryplaylists/README.md#getplaylistgenerators) - Get a playlist's generators
* [clearPlaylistItems](docs/sdks/libraryplaylists/README.md#clearplaylistitems) - Clearing a playlist
* [addPlaylistItems](docs/sdks/libraryplaylists/README.md#addplaylistitems) - Adding to a Playlist
* [deletePlaylistItem](docs/sdks/libraryplaylists/README.md#deleteplaylistitem) - Delete a Generator
* [getPlaylistGenerator](docs/sdks/libraryplaylists/README.md#getplaylistgenerator) - Get a playlist generator
* [getPlaylistGeneratorItems](docs/sdks/libraryplaylists/README.md#getplaylistgeneratoritems) - Get a playlist generator's items
* [movePlaylistItem](docs/sdks/libraryplaylists/README.md#moveplaylistitem) - Moving items in a playlist
* [refreshPlaylist](docs/sdks/libraryplaylists/README.md#refreshplaylist) - Reprocess a generator
### [liveTV()](docs/sdks/livetv/README.md)
* [getSessions](docs/sdks/livetv/README.md#getsessions) - Get all sessions
* [getLiveTVSession](docs/sdks/livetv/README.md#getlivetvsession) - Get a single session
* [getSessionPlaylistIndex](docs/sdks/livetv/README.md#getsessionplaylistindex) - Get a session playlist index
* [getSessionSegment](docs/sdks/livetv/README.md#getsessionsegment) - Get a single session segment
### [log()](docs/sdks/log/README.md)
* [writeLog](docs/sdks/log/README.md#writelog) - Logging a multi-line message to the Plex Media Server log
* [writeMessage](docs/sdks/log/README.md#writemessage) - Logging a single-line message to the Plex Media Server log
* [enablePapertrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
### [playlist()](docs/sdks/playlist/README.md)
* [listPlaylists](docs/sdks/playlist/README.md#listplaylists) - List playlists
* [getPlaylist](docs/sdks/playlist/README.md#getplaylist) - Retrieve Playlist
* [getPlaylistItems](docs/sdks/playlist/README.md#getplaylistitems) - Retrieve Playlist Contents
### [playQueue()](docs/sdks/playqueue/README.md)
* [createPlayQueue](docs/sdks/playqueue/README.md#createplayqueue) - Create a play queue
* [getPlayQueue](docs/sdks/playqueue/README.md#getplayqueue) - Retrieve a play queue
* [addToPlayQueue](docs/sdks/playqueue/README.md#addtoplayqueue) - Add a generator or playlist to a play queue
* [clearPlayQueue](docs/sdks/playqueue/README.md#clearplayqueue) - Clear a play queue
* [resetPlayQueue](docs/sdks/playqueue/README.md#resetplayqueue) - Reset a play queue
* [shuffle](docs/sdks/playqueue/README.md#shuffle) - Shuffle a play queue
* [unshuffle](docs/sdks/playqueue/README.md#unshuffle) - Unshuffle a play queue
* [deletePlayQueueItem](docs/sdks/playqueue/README.md#deleteplayqueueitem) - Delete an item from a play queue
* [movePlayQueueItem](docs/sdks/playqueue/README.md#moveplayqueueitem) - Move an item in a play queue
### [preferences()](docs/sdks/preferences/README.md)
* [getAllPreferences](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
* [setPreferences](docs/sdks/preferences/README.md#setpreferences) - Set preferences
* [getPreference](docs/sdks/preferences/README.md#getpreference) - Get a preferences
### [provider()](docs/sdks/provider/README.md)
* [listProviders](docs/sdks/provider/README.md#listproviders) - Get the list of available media providers
* [addProvider](docs/sdks/provider/README.md#addprovider) - Add a media provider
* [refreshProviders](docs/sdks/provider/README.md#refreshproviders) - Refresh media providers
* [deleteMediaProvider](docs/sdks/provider/README.md#deletemediaprovider) - Delete a media provider
### [rate()](docs/sdks/rate/README.md)
* [setRating](docs/sdks/rate/README.md#setrating) - Rate an item
### [search()](docs/sdks/search/README.md)
* [searchHubs](docs/sdks/search/README.md#searchhubs) - Search Hub
* [voiceSearchHubs](docs/sdks/search/README.md#voicesearchhubs) - Voice Search Hub
### [status()](docs/sdks/status/README.md)
* [listSessions](docs/sdks/status/README.md#listsessions) - List Sessions
* [getBackgroundTasks](docs/sdks/status/README.md#getbackgroundtasks) - Get background tasks
* [listPlaybackHistory](docs/sdks/status/README.md#listplaybackhistory) - List Playback History
* [terminateSession](docs/sdks/status/README.md#terminatesession) - Terminate a session
* [deleteHistory](docs/sdks/status/README.md#deletehistory) - Delete Single History Item
* [getHistoryItem](docs/sdks/status/README.md#gethistoryitem) - Get Single History Item
### [subscriptions()](docs/sdks/subscriptions/README.md)
* [getAllSubscriptions](docs/sdks/subscriptions/README.md#getallsubscriptions) - Get all subscriptions
* [createSubscription](docs/sdks/subscriptions/README.md#createsubscription) - Create a subscription
* [processSubscriptions](docs/sdks/subscriptions/README.md#processsubscriptions) - Process all subscriptions
* [getScheduledRecordings](docs/sdks/subscriptions/README.md#getscheduledrecordings) - Get all scheduled recordings
* [getTemplate](docs/sdks/subscriptions/README.md#gettemplate) - Get the subscription template
* [cancelGrab](docs/sdks/subscriptions/README.md#cancelgrab) - Cancel an existing grab
* [deleteSubscription](docs/sdks/subscriptions/README.md#deletesubscription) - Delete a subscription
* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Get a single subscription
* [editSubscriptionPreferences](docs/sdks/subscriptions/README.md#editsubscriptionpreferences) - Edit a subscription
* [reorderSubscription](docs/sdks/subscriptions/README.md#reordersubscription) - Re-order a subscription
### [timeline()](docs/sdks/timeline/README.md)
* [markPlayed](docs/sdks/timeline/README.md#markplayed) - Mark an item as played
* [report](docs/sdks/timeline/README.md#report) - Report media timeline
* [unscrobble](docs/sdks/timeline/README.md#unscrobble) - Mark an item as unplayed
### [transcoder()](docs/sdks/transcoder/README.md)
* [transcodeImage](docs/sdks/transcoder/README.md#transcodeimage) - Transcode an image
* [makeDecision](docs/sdks/transcoder/README.md#makedecision) - Make a decision on media playback
* [triggerFallback](docs/sdks/transcoder/README.md#triggerfallback) - Manually trigger a transcoder fallback
* [transcodeSubtitles](docs/sdks/transcoder/README.md#transcodesubtitles) - Transcode subtitles
* [startTranscodeSession](docs/sdks/transcoder/README.md#starttranscodesession) - Start A Transcoding Session
### [ultraBlur()](docs/sdks/ultrablur/README.md)
* [getColors](docs/sdks/ultrablur/README.md#getcolors) - Get UltraBlur Colors
* [getImage](docs/sdks/ultrablur/README.md#getimage) - Get UltraBlur Image
### [updater()](docs/sdks/updater/README.md)
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Applying updates
* [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates
* [getUpdatesStatus](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of updates
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] -->
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerInfo` method throws the following exceptions:
| Error Type | Status Code | Content Type |
| ---------------------- | ----------- | ------------ |
| models/errors/SDKError | 4XX, 5XX | \*/\* |
### Example
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetServerInfoRequest req = GetServerInfoRequest.builder()
.build();
GetServerInfoResponse res = sdk.general().getServerInfo()
.request(req)
.call();
if (res.mediaContainerWithDirectory().isPresent()) {
// handle response
}
}
}
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
You can override the default server globally using the `.serverIndex(int serverIdx)` builder method 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 | Description |
| --- | ---------------------------------------------------------- | -------------------------------------------- | ----------- |
| 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<br/>`port` | |
| 2 | `https://{full_server_url}` | `server_url` | |
If the selected server has variables, you may override its default values using the associated builder method(s):
| Variable | BuilderMethod | Default | Description |
| ---------------- | ------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `identifier` | `identifier(String identifier)` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
| `IP-description` | `ipDescription(String ipDescription)` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
| `port` | `port(String port)` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
| `protocol` | `protocol(String protocol)` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
| `host` | `host(String host)` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
| `server_url` | `serverUrl(String serverUrl)` | `"http://localhost:32400"` | The full manual URL to access the PMS |
#### Example
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
PlexAPI sdk = PlexAPI.builder()
.serverIndex(1)
.protocol("<value>")
.host("electric-excess.name")
.port("36393")
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetServerInfoRequest req = GetServerInfoRequest.builder()
.build();
GetServerInfoResponse res = sdk.general().getServerInfo()
.request(req)
.call();
if (res.mediaContainerWithDirectory().isPresent()) {
// handle response
}
}
}
```
### Override Server URL Per-Client
The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
PlexAPI sdk = PlexAPI.builder()
.serverURL("https://{full_server_url}")
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetServerInfoRequest req = GetServerInfoRequest.builder()
.build();
GetServerInfoResponse res = sdk.general().getServerInfo()
.request(req)
.call();
if (res.mediaContainerWithDirectory().isPresent()) {
// handle response
}
}
}
```
<!-- End Server Selection [server] -->
<!-- Start Asynchronous Support [async-support] -->
## Asynchronous Support
The SDK provides comprehensive asynchronous support using Java's [`CompletableFuture<T>`][comp-fut] and [Reactive Streams `Publisher<T>`][reactive-streams] APIs. This design makes no assumptions about your choice of reactive toolkit, allowing seamless integration with any reactive library.
<details>
<summary>Why Use Async?</summary>
Asynchronous operations provide several key benefits:
- **Non-blocking I/O**: Your threads stay free for other work while operations are in flight
- **Better resource utilization**: Handle more concurrent operations with fewer threads
- **Improved scalability**: Build highly responsive applications that can handle thousands of concurrent requests
- **Reactive integration**: Works seamlessly with reactive streams and backpressure handling
</details>
<details>
<summary>Reactive Library Integration</summary>
The SDK returns [Reactive Streams `Publisher<T>`][reactive-streams] instances for operations dealing with streams involving multiple I/O interactions. We use Reactive Streams instead of JDK Flow API to provide broader compatibility with the reactive ecosystem, as most reactive libraries natively support Reactive Streams.
**Why Reactive Streams over JDK Flow?**
- **Broader ecosystem compatibility**: Most reactive libraries (Project Reactor, RxJava, Akka Streams, etc.) natively support Reactive Streams
- **Industry standard**: Reactive Streams is the de facto standard for reactive programming in Java
- **Better interoperability**: Seamless integration without additional adapters for most use cases
**Integration with Popular Libraries:**
- **Project Reactor**: Use `Flux.from(publisher)` to convert to Reactor types
- **RxJava**: Use `Flowable.fromPublisher(publisher)` for RxJava integration
- **Akka Streams**: Use `Source.fromPublisher(publisher)` for Akka Streams integration
- **Vert.x**: Use `ReadStream.fromPublisher(vertx, publisher)` for Vert.x reactive streams
- **Mutiny**: Use `Multi.createFrom().publisher(publisher)` for Quarkus Mutiny integration
**For JDK Flow API Integration:**
If you need JDK Flow API compatibility (e.g., for Quarkus/Mutiny 2), you can use adapters:
```java
// Convert Reactive Streams Publisher to Flow Publisher
Flow.Publisher<T> flowPublisher = FlowAdapters.toFlowPublisher(reactiveStreamsPublisher);
// Convert Flow Publisher to Reactive Streams Publisher
Publisher<T> reactiveStreamsPublisher = FlowAdapters.toPublisher(flowPublisher);
```
For standard single-response operations, the SDK returns `CompletableFuture<T>` for straightforward async execution.
</details>
<details>
<summary>Supported Operations</summary>
Async support is available for:
- **[Server-sent Events](#server-sent-event-streaming)**: Stream real-time events with Reactive Streams `Publisher<T>`
- **[JSONL Streaming](#jsonl-streaming)**: Process streaming JSON lines asynchronously
- **[Pagination](#pagination)**: Iterate through paginated results using `callAsPublisher()` and `callAsPublisherUnwrapped()`
- **[File Uploads](#file-uploads)**: Upload files asynchronously with progress tracking
- **[File Downloads](#file-downloads)**: Download files asynchronously with streaming support
- **[Standard Operations](#example)**: All regular API calls return `CompletableFuture<T>` for async execution
</details>
[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html
[reactive-streams]: https://www.reactive-streams.org/
<!-- End Asynchronous Support [async-support] -->
<!-- Start Authentication [security] -->
## Authentication
To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.
### Per-Client Security Schemes
### API Key
The PlexSDK API uses API keys as a form of authentication.
An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.
This SDK supports the following security scheme globally:
The API key can be set for the SDK through:
| Name | Type | Scheme |
| ------- | ------ | ------- |
| `token` | apiKey | API key |
```Java
PlexSDK sdk = new PlexSDK("YOUR_API_KEY", "YOUR_API_KEY_HEADER");
```
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```java
package hello.world;
## API Endpoint Services
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetServerInfoRequest;
import dev.plexapi.sdk.models.operations.GetServerInfoResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
All URIs are relative to http://10.10.10.47:32400.
public class Application {
Click the service name for a full list of the service methods.
public static void main(String[] args) throws Exception {
| Service |
| :------ |
|[ServerService](src/main/java/47/one0/services/README.md#serverservice)|
|[MediaService](src/main/java/47/one0/services/README.md#mediaservice)|
|[ActivitiesService](src/main/java/47/one0/services/README.md#activitiesservice)|
|[ButlerService](src/main/java/47/one0/services/README.md#butlerservice)|
|[HubsService](src/main/java/47/one0/services/README.md#hubsservice)|
|[SearchService](src/main/java/47/one0/services/README.md#searchservice)|
|[LibraryService](src/main/java/47/one0/services/README.md#libraryservice)|
|[LogService](src/main/java/47/one0/services/README.md#logservice)|
|[PlaylistsService](src/main/java/47/one0/services/README.md#playlistsservice)|
|[SecurityService](src/main/java/47/one0/services/README.md#securityservice)|
|[SessionsService](src/main/java/47/one0/services/README.md#sessionsservice)|
|[UpdaterService](src/main/java/47/one0/services/README.md#updaterservice)|
|[VideoService](src/main/java/47/one0/services/README.md#videoservice)|
PlexAPI sdk = PlexAPI.builder()
.token(System.getenv().getOrDefault("TOKEN", ""))
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.build();
## API Models
[A list documenting all API models for this SDK](src/main/java/47/one0//models/README.md#plexsdk-models).
GetServerInfoRequest req = GetServerInfoRequest.builder()
.build();
## Testing
GetServerInfoResponse res = sdk.general().getServerInfo()
.request(req)
.call();
Unit tests aren't available yet. When they are, you'll be able to run them with this command:
```Bash
mvn clean test
```
## Configuration
Your SDK may require some configuration changes.
This API is configured to use a security token for authorization. You should edit `examples/src/main/java/47/one0/examples/Main.java` and paste your own tokens in place of `PLEXSDK_API_KEY` & `PLEXSDK_API_KEY_HEADER`.
## Sample Usage
```Java
package 47.one0.examples;
import 47.one0.exceptions.ApiException;
import 47.one0.PlexSDK;
public class Main {
public static void main(String[] args) {
PlexSDK client = new PlexSDK(System.getenv("PLEXSDK_API_KEY"), System.getenv("PLEXSDK_API_KEY_HEADER"));
try {
Object response = client.serverService.getServerCapabilities();
System.out.println(response);
} catch(ApiException e) {
e.printStackTrace();
if (res.mediaContainerWithDirectory().isPresent()) {
// handle response
}
}
}
}
```
<!-- End Authentication [security] -->
Inside this directory is `examples/src/main/java/47/one0/examples/Main.java`. It's a simple, "hello, world" level program to demonstate this SDK. Run `install.sh` to prepare the SDK for use.
<!-- Start Debugging [debug] -->
## Debugging
To see what other functions this SDK is capable of, look inside `src/main/java/47/one0/http/*Client.java`.
### Debug
You can setup your SDK to emit debug logs for SDK requests and responses.
## License
For request and response logging (especially json bodies), call `enableHTTPDebugLogging(boolean)` on the SDK builder like so:
```java
SDK.builder()
.enableHTTPDebugLogging(true)
.build();
```
Example output:
```
Sending request: http://localhost:35123/bearer#global GET
Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
Received response: (GET http://localhost:35123/bearer#global) 200
Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
Response body:
{
"authenticated": true,
"token": "global"
}
```
__WARNING__: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
License: MIT. See license in LICENSE.
__NOTE__: This is a convenience method that calls `HTTPClient.enableDebugLogging()`. The `SpeakeasyHTTPClient` honors this setting. If you are using a custom HTTP client, it is up to the custom client to honor this setting.
Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
<!-- End Debugging [debug] -->
<!-- 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. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with 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)

401
RELEASES.md Normal file
View File

@@ -0,0 +1,401 @@
## 2024-09-13 00:24:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.0] .
### Releases
- [Maven Central v0.3.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.0 - .
## 2024-09-16 18:23:01
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.1] .
### Releases
- [Maven Central v0.3.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.1 - .
## 2024-09-16 18:32:47
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.2] .
### Releases
- [Maven Central v0.3.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.2 - .
## 2024-09-16 18:54:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.3] .
### Releases
- [Maven Central v0.3.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.3 - .
## 2024-09-16 19:14:13
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.3 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.4] .
### Releases
- [Maven Central v0.3.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.4 - .
## 2024-09-16 19:32:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.397.3 (2.415.8) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.5] .
### Releases
- [Maven Central v0.3.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.5 - .
## 2024-09-19 00:24:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.3.6] .
### Releases
- [Maven Central v0.3.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.3.6 - .
## 2024-09-21 00:24:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.4.0] .
### Releases
- [Maven Central v0.4.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.0 - .
## 2024-09-22 00:27:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.4.1] .
### Releases
- [Maven Central v0.4.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.4.1 - .
## 2024-09-26 00:25:07
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.5.0] .
### Releases
- [Maven Central v0.5.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.5.0 - .
## 2024-09-28 00:25:08
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.6.0] .
### Releases
- [Maven Central v0.6.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.0 - .
## 2024-09-29 00:28:35
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.6.1] .
### Releases
- [Maven Central v0.6.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.1 - .
## 2024-09-30 00:26:54
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.6.2] .
### Releases
- [Maven Central v0.6.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.6.2 - .
## 2024-10-01 00:28:45
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.7.0] .
### Releases
- [Maven Central v0.7.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.7.0 - .
## 2024-10-03 00:26:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.8.0] .
### Releases
- [Maven Central v0.8.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.8.0 - .
## 2024-10-04 00:25:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.9.0] .
### Releases
- [Maven Central v0.9.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.9.0 - .
## 2024-11-12 00:25:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.10.0] .
### Releases
- [Maven Central v0.10.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.0 - .
## 2024-11-14 00:25:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.439.0 (2.457.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.10.1] .
### Releases
- [Maven Central v0.10.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.10.1 - .
## 2024-12-21 00:25:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.0] .
### Releases
- [Maven Central v0.11.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.0 - .
## 2024-12-22 00:28:49
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.1] .
### Releases
- [Maven Central v0.11.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.1 - .
## 2025-01-24 00:25:37
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.2] .
### Releases
- [Maven Central v0.11.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.2 - .
## 2025-01-27 00:26:34
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.3] .
### Releases
- [Maven Central v0.11.3] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.3 - .
## 2025-02-05 00:25:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.4] .
### Releases
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
## 2025-02-06 00:26:06
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.5] .
### Releases
- [Maven Central v0.11.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.5 - .
## 2025-02-07 00:26:07
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.11.6] .
### Releases
- [Maven Central v0.11.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.6 - .
## 2025-02-10 00:27:03
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.12.0] .
### Releases
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
## 2025-03-07 00:27:17
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.13.0] .
### Releases
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
## 2025-03-09 00:24:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.13.1] .
### Releases
- [Maven Central v0.13.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.1 - .
## 2025-03-31 17:07:30
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.14.0] .
### Releases
- [Maven Central v0.14.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.0 - .
## 2025-04-03 00:27:41
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.14.1] .
### Releases
- [Maven Central v0.14.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.1 - .
## 2025-04-06 00:30:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.14.2] .
### Releases
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
## 2025-04-14 00:30:37
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.15.0] .
### Releases
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
## 2025-04-19 00:27:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.16.0] .
### Releases
- [Maven Central v0.16.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.0 - .
## 2025-05-01 00:32:51
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.16.1] .
### Releases
- [Maven Central v0.16.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.1 - .
## 2025-05-05 00:31:37
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.16.2] .
### Releases
- [Maven Central v0.16.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.2 - .
## 2025-06-04 00:30:54
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.17.0] .
### Releases
- [Maven Central v0.17.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.0 - .
## 2025-06-09 00:32:43
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.17.1] .
### Releases
- [Maven Central v0.17.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.1 - .
## 2025-09-16 00:27:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.18.0] .
### Releases
- [Maven Central v0.18.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.18.0 - .
## 2025-10-12 06:49:36
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.19.1] .
### Releases
- [Maven Central v0.19.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.19.1 - .
## 2025-10-13 00:31:03
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.20.1] .
### Releases
- [Maven Central v0.20.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.20.1 - .

71
USAGE.md Normal file
View File

@@ -0,0 +1,71 @@
<!-- Start SDK Example Usage [usage] -->
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
StartTranscodeSessionRequest req = StartTranscodeSessionRequest.builder()
.transcodeType(TranscodeType.MUSIC)
.extension(Extension.MPD)
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.location(StartTranscodeSessionQueryParamLocation.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)
.musicBitrate(5000L)
.offset(90.5)
.partIndex(0L)
.path("/library/metadata/151671")
.peakBitrate(12000L)
.photoResolution("1080x1080")
.protocol(StartTranscodeSessionQueryParamProtocol.DASH)
.secondsPerSegment(5L)
.subtitleSize(50L)
.videoBitrate(12000L)
.videoQuality(50L)
.videoResolution("1080x1080")
.xPlexClientProfileExtra("add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)")
.xPlexClientProfileName("generic")
.build();
StartTranscodeSessionResponse res = sdk.transcoder().startTranscodeSession()
.request(req)
.call();
if (res.responseStream().isPresent()) {
// handle response
}
}
}
```
<!-- End SDK Example Usage [usage] -->

4
build-extras.gradle Normal file
View File

@@ -0,0 +1,4 @@
// This file
// * is referred to in an `apply from` command in `build.gradle`
// * can be used to customise `build.gradle`
// * is generated once and not overwritten in SDK generation updates

167
build.gradle Normal file
View File

@@ -0,0 +1,167 @@
////////////////////////////////////////////////////////////////////////////////////////////
// This file is generated by Speakeasy and any edits will be lost in generation updates.
//
// If you wish to customize this file then place those customizations in `build-extras.gradle` which
// is not touched by generation updates.
//
// Additions to the plugins block can be made by setting the `additionalPlugins` property (an array
// of string where each string value is an additional line in the block) in gen.yaml.
////////////////////////////////////////////////////////////////////////////////////////////
plugins {
// Apply the java-library plugin for API and implementation separation.
id 'java-library'
id 'maven-publish'
id 'signing'
id 'cl.franciscosolis.sonatype-central-upload' version '1.0.3'
}
compileJava.options.encoding = "UTF-8"
compileJava.options.compilerArgs += '-Xlint:unchecked'
compileTestJava.options.encoding = "UTF-8"
repositories {
// Use Maven Central for resolving dependencies.
mavenCentral()
}
java {
withSourcesJar()
withJavadocJar()
}
model {
tasks.generatePomFileForMavenPublication {
destination = file("$buildDir/pom.xml")
}
}
version = "${version}"
group = "${groupId}"
jar {
dependsOn(":generatePomFileForMavenPublication")
archiveBaseName = "${artifactId}"
into("META-INF/maven/dev.plexapi/plexapi") {
from("$buildDir/pom.xml")
}
}
javadoc {
options.encoding = "UTF-8"
if(JavaVersion.current().isJava9Compatible()) {
options.addBooleanOption('html5', true)
}
options.addStringOption('Xdoclint:none', '-quiet')
}
tasks.withType(Javadoc) {
failOnError = false
options.addStringOption('Xdoclint:none', '-quiet')
}
tasks.withType(JavaCompile).configureEach {
options.release = 11
}
sourcesJar {
archiveBaseName = "${artifactId}"
}
javadocJar {
archiveBaseName = "${artifactId}"
}
sonatypeCentralUpload {
// This is your Sonatype generated username
username = System.getenv("SONATYPE_USERNAME")
// This is your sonatype generated password
password = System.getenv("SONATYPE_PASSWORD")
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
archives = files(
"$buildDir/libs/${artifactId}-${version}.jar",
"$buildDir/libs/${artifactId}-${version}-sources.jar",
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
)
// This is the pom file to upload. This is required by central
pom = file("$buildDir/pom.xml")
// This is your PGP private key. This is required to sign your files
signingKey = System.getenv("SONATYPE_SIGNING_KEY")
// This is your PGP private key passphrase to decrypt your private key
signingKeyPassphrase = System.getenv("SIGNING_KEY_PASSPHRASE")
}
publishing {
publications {
maven(MavenPublication) {
// note that properties can't yet be used below!
// https://github.com/gradle/gradle/issues/18619
groupId = "dev.plexapi"
artifactId = "plexapi"
version = "0.20.1"
from components.java
pom {
properties = [
'maven.compiler.source': '11',
'maven.compiler.target': '11',
]
name = 'plexapi Java SDK'
description = 'SDK enabling Java developers to easily integrate with the plexapi API.'
url = 'https://github.com/LukeHagar/plexjava'
scm {
url = 'github.com/LukeHagar/plexjava'
connection = 'scm:git:ssh://git@github.com/LukeHagar/plexjava.git'
}
licenses {
license {
name = 'The MIT License (MIT)'
url = 'https://mit-license.org/'
}
}
developers {
developer {
name = 'plexapi'
organization = 'plexapi'
email = 'lukeslakemail@gmail.com'
}
}
organization {
name = 'plexapi'
url = 'plexapi.dev'
}
}
}
}
}
if (!project.hasProperty('skip.signing')) {
signing {
def signingKey = findProperty("signingKey")
def signingPassphrase = findProperty("signingPassphrase")
useInMemoryPgpKeys(signingKey, signingPassphrase)
sign publishing.publications.maven
}
}
dependencies {
api 'com.fasterxml.jackson.core:jackson-annotations:2.18.2'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.18.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
implementation 'commons-io:commons-io:2.18.0'
api 'org.reactivestreams:reactive-streams:1.0.4'
}
apply from: 'build-extras.gradle'

10687
codeSamples.yaml Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,9 @@
# Account
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `globalViewCount` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `id` | *Optional\<Long>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,12 @@
# Action
The action to perform for this item on this optimizer queue
## Values
| Name | Value |
| ----------- | ----------- |
| `REPROCESS` | reprocess |
| `DISABLE` | disable |
| `ENABLE` | enable |

View File

@@ -0,0 +1,16 @@
# Activity
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `cancellable` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether this activity can be cancelled |
| `context` | Map\<String, *Object*> | :heavy_minus_sign: | An object with additional values |
| `progress` | *Optional\<Double>* | :heavy_minus_sign: | A progress percentage. A value of -1 means the progress is indeterminate |
| `response` | Map\<String, *Object*> | :heavy_minus_sign: | An object with the response to the async opperation |
| `subtitle` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly sub-title for this activity |
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title for this activity |
| `type` | *Optional\<String>* | :heavy_minus_sign: | The type of activity |
| `userID` | *Optional\<Long>* | :heavy_minus_sign: | The user this activity belongs to |
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | The ID of the activity |

View File

@@ -0,0 +1,20 @@
# AddCollectionItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `collectionId` | *long* | :heavy_check_mark: | The collection id | |
| `uri` | *String* | :heavy_check_mark: | The URI describing the items to add to this collection | |

View File

@@ -0,0 +1,11 @@
# AddCollectionItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# AddDeviceRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI of the device. | http://10.0.0.5 |

View File

@@ -0,0 +1,11 @@
# AddDeviceResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithDevice` | [Optional\<MediaContainerWithDevice>](../../models/shared/MediaContainerWithDevice.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,12 @@
# AddDeviceToDVRDVR
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `device` | List\<[Device](../../models/shared/Device.md)> | :heavy_minus_sign: | N/A |
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddDeviceToDVRDVRsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `status` | *Optional\<Long>* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |

View File

@@ -0,0 +1,9 @@
# AddDeviceToDVRMediaContainer
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<AddDeviceToDVRDVRsMediaContainer>](../../models/operations/AddDeviceToDVRDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | List\<[AddDeviceToDVRDVR](../../models/operations/AddDeviceToDVRDVR.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,20 @@
# AddDeviceToDVRRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `dvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
| `deviceId` | *long* | :heavy_check_mark: | The ID of the device to add. | |

View File

@@ -0,0 +1,12 @@
# AddDeviceToDVRResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional\<AddDeviceToDVRResponseBody>](../../models/operations/AddDeviceToDVRResponseBody.md) | :heavy_minus_sign: | OK |
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# AddDeviceToDVRResponseBody
OK
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<AddDeviceToDVRMediaContainer>](../../models/operations/AddDeviceToDVRMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddDownloadQueueItemsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `addedQueueItems` | List\<[AddedQueueItems](../../models/operations/AddedQueueItems.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,46 @@
# AddDownloadQueueItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `queueId` | *long* | :heavy_check_mark: | The queue id | |
| `keys` | List\<*String*> | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
| `advancedSubtitles` | [Optional\<AdvancedSubtitles>](../../models/shared/AdvancedSubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
| `audioBoost` | *Optional\<Long>* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
| `audioChannelCount` | *Optional\<Long>* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
| `autoAdjustQuality` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
| `autoAdjustSubtitle` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
| `directPlay` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
| `directStream` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
| `directStreamAudio` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
| `disableResolutionRotation` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
| `hasMDE` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
| `location` | [Optional\<Location>](../../models/shared/Location.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
| `mediaBufferSize` | *Optional\<Long>* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
| `mediaIndex` | *Optional\<Long>* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
| `musicBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
| `offset` | *Optional\<Double>* | :heavy_minus_sign: | Offset from the start of the media (in seconds). | 90.5 |
| `partIndex` | *Optional\<Long>* | :heavy_minus_sign: | Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode | 0 |
| `path` | *Optional\<String>* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
| `peakBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
| `photoResolution` | *Optional\<String>* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
| `protocol` | [Optional\<Protocol>](../../models/shared/Protocol.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
| `secondsPerSegment` | *Optional\<Long>* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
| `subtitleSize` | *Optional\<Long>* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
| `subtitles` | [Optional\<Subtitles>](../../models/shared/Subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
| `videoBitrate` | *Optional\<Long>* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
| `videoQuality` | *Optional\<Long>* | :heavy_minus_sign: | Target photo quality. | 50 |
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |

View File

@@ -0,0 +1,11 @@
# AddDownloadQueueItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional\<AddDownloadQueueItemsResponseBody>](../../models/operations/AddDownloadQueueItemsResponseBody.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,10 @@
# AddDownloadQueueItemsResponseBody
OK
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<AddDownloadQueueItemsMediaContainer>](../../models/operations/AddDownloadQueueItemsMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,22 @@
# AddExtrasRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *String* | :heavy_check_mark: | N/A | |
| `extraType` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type of the extra | |
| `url` | *String* | :heavy_check_mark: | The URL of the extra | |
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |

View File

@@ -0,0 +1,10 @@
# AddExtrasResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,12 @@
# AddLineupDVR
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `device` | List\<[Device](../../models/shared/Device.md)> | :heavy_minus_sign: | N/A |
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddLineupDVRsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `status` | *Optional\<Long>* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |

View File

@@ -0,0 +1,9 @@
# AddLineupMediaContainer
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [Optional\<AddLineupDVRsMediaContainer>](../../models/operations/AddLineupDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | List\<[AddLineupDVR](../../models/operations/AddLineupDVR.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,20 @@
# AddLineupRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `dvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
| `lineup` | *String* | :heavy_check_mark: | The lineup to delete | |

View File

@@ -0,0 +1,12 @@
# AddLineupResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional\<AddLineupResponseBody>](../../models/operations/AddLineupResponseBody.md) | :heavy_minus_sign: | OK |
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# AddLineupResponseBody
OK
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<AddLineupMediaContainer>](../../models/operations/AddLineupMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,21 @@
# AddPlaylistItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playlistId` | *long* | :heavy_check_mark: | The ID of the playlist | |
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The content URI for the playlist. | |
| `playQueueID` | *Optional\<Long>* | :heavy_minus_sign: | The play queue to add to a playlist. | |

View File

@@ -0,0 +1,11 @@
# AddPlaylistItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# AddProviderRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `url` | *String* | :heavy_check_mark: | The URL of the media provider to add. | |

View File

@@ -0,0 +1,10 @@
# AddProviderResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,28 @@
# AddSectionRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `name` | *String* | :heavy_check_mark: | The name of the new section | |
| `type` | *long* | :heavy_check_mark: | The type of library section | |
| `scanner` | *Optional\<String>* | :heavy_minus_sign: | The scanner this section should use | |
| `agent` | *String* | :heavy_check_mark: | The agent this section should use for metadata | |
| `metadataAgentProviderGroupId` | *Optional\<String>* | :heavy_minus_sign: | The agent group id for this section | |
| `language` | *String* | :heavy_check_mark: | The language of this section | |
| `locations` | List\<*String*> | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
| `prefs` | [Optional\<QueryParamPrefs>](../../models/operations/QueryParamPrefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
| `relative` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
| `importFromiTunes` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |

View File

@@ -0,0 +1,11 @@
# AddSectionResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `slashGetResponses200` | [Optional\<SlashGetResponses200>](../../models/shared/SlashGetResponses200.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,26 @@
# AddSubtitlesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *String* | :heavy_check_mark: | N/A | |
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
| `language` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
| `mediaItemID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
| `url` | *Optional\<String>* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
| `format` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
| `forced` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
| `hearingImpaired` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |

View File

@@ -0,0 +1,10 @@
# AddSubtitlesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,22 @@
# AddToPlayQueueRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
| `playlistID` | *Optional\<String>* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
| `next` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |

View File

@@ -0,0 +1,11 @@
# AddToPlayQueueResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,9 @@
# AddedQueueItems
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional\<Long>* | :heavy_minus_sign: | The queue item id that was added or the existing one if an item already exists in this queue with the same parameters |
| `key` | *Optional\<String>* | :heavy_minus_sign: | The key added to the queue |

View File

@@ -0,0 +1,13 @@
# AdvancedSubtitles
## Values
| Name | Value |
| ----------- | ----------- |
| `AUTO` | auto |
| `BURN` | burn |
| `NONE` | none |
| `SIDECAR` | sidecar |
| `EMBEDDED` | embedded |
| `SEGMENTED` | segmented |

View File

@@ -0,0 +1,21 @@
# AnalyzeMetadataRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *String* | :heavy_check_mark: | N/A | |
| `thumbOffset` | *Optional\<Double>* | :heavy_minus_sign: | Set the offset to be used for thumbnails | |
| `artOffset` | *Optional\<Double>* | :heavy_minus_sign: | Set the offset to be used for artwork | |

View File

@@ -0,0 +1,10 @@
# AnalyzeMetadataResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,20 @@
# ApplyUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `tonight` | [Optional\<BoolInt>](../../models/shared/BoolInt.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 immediately. | 1 |
| `skip` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |

View File

@@ -0,0 +1,10 @@
# ApplyUpdatesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,9 @@
# Args
The new values for the metadata item
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,9 @@
# Attributes
The attributes to assign to this marker
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,22 @@
# AutocompleteRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |
| `type` | *Optional\<Long>* | :heavy_minus_sign: | Item type | |
| `fieldQuery` | *Optional\<String>* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
| `mediaQuery` | [Optional\<MediaQuery>](../../models/shared/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |

View File

@@ -0,0 +1,12 @@
# AutocompleteResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# Bandwidth
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `bandwidth` | *Optional\<Long>* | :heavy_minus_sign: | The bandwidth at this time in kbps |
| `resolution` | *Optional\<String>* | :heavy_minus_sign: | The user-friendly resolution at this time |
| `time` | *Optional\<Long>* | :heavy_minus_sign: | Media playback time where this bandwidth started |

View File

@@ -0,0 +1,10 @@
# Bandwidths
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `bandwidth` | List\<[Bandwidth](../../models/operations/Bandwidth.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,13 @@
# ButlerTask
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `description` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly description of the task |
| `enabled` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this task is enabled or not |
| `interval` | *Optional\<Long>* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
| `name` | *Optional\<String>* | :heavy_minus_sign: | The name of the task |
| `scheduleRandomized` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
| `title` | *Optional\<String>* | :heavy_minus_sign: | A user-friendly title of the task |

View File

@@ -0,0 +1,8 @@
# ButlerTasks
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `butlerTask` | List\<[ButlerTask](../../models/operations/ButlerTask.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,19 @@
# CancelActivityRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `activityId` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. | d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e |

View File

@@ -0,0 +1,10 @@
# CancelActivityResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# CancelGrabRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `operationId` | *String* | :heavy_check_mark: | The ID of the operation. | |

View File

@@ -0,0 +1,10 @@
# CancelGrabResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# CancelRefreshRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *long* | :heavy_check_mark: | Section identifier | |

View File

@@ -0,0 +1,10 @@
# CancelRefreshResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,9 @@
# ChannelMapping
The mapping of changes, passed as a map of device channel to lineup VCN.
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,9 @@
# ChannelMappingByKey
The mapping of changes, passed as a map of device channel to lineup key.
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,19 @@
# CheckUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `download` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -0,0 +1,10 @@
# CheckUpdatesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# ChromaSubsampling
Use the specified chroma subsambling.
- 0: 411
- 1: 420
- 2: 422
- 3: 444
Defaults to 3 (444)
## Values
| Name | Value |
| ------- | ------- |
| `ZERO` | 0 |
| `ONE` | 1 |
| `TWO` | 2 |
| `THREE` | 3 |

View File

@@ -0,0 +1,10 @@
# CleanBundlesResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# ClearPlayQueueRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |

View File

@@ -0,0 +1,11 @@
# ClearPlayQueueResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# ClearPlaylistItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playlistId` | *long* | :heavy_check_mark: | The ID of the playlist | |

View File

@@ -0,0 +1,11 @@
# ClearPlaylistItemsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithPlaylistMetadata` | [Optional\<MediaContainerWithPlaylistMetadata>](../../models/shared/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,11 @@
# ComputeChannelMapChannelMapping
## Fields
| Field | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `channelKey` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `deviceIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The channel description on the device |
| `favorite` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
| `lineupIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The channel identifier in the lineup |

View File

@@ -0,0 +1,17 @@
# ComputeChannelMapMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `channelMapping` | List\<[ComputeChannelMapChannelMapping](../../models/operations/ComputeChannelMapChannelMapping.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,20 @@
# ComputeChannelMapRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `deviceQueryParameter` | *String* | :heavy_check_mark: | The URI describing the device | |
| `lineup` | *String* | :heavy_check_mark: | The URI describing the lineup | |

View File

@@ -0,0 +1,12 @@
# ComputeChannelMapResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [Optional\<ComputeChannelMapResponseBody>](../../models/operations/ComputeChannelMapResponseBody.md) | :heavy_minus_sign: | OK |
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# ComputeChannelMapResponseBody
OK
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<ComputeChannelMapMediaContainer>](../../models/operations/ComputeChannelMapMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,19 @@
# ConnectWebSocketRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `filter` | List\<*String*> | :heavy_minus_sign: | By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:<br/><br/>- `filters=-log`: All event types except logs (the default).<br/>- `filters=foo,bar`: Only the foo and bar event types.<br/>- `filters=`: All events types.<br/>- `filters=-foo,bar`: All event types except foo and bar.<br/> | |

View File

@@ -0,0 +1,11 @@
# ConnectWebSocketResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `responseStream` | *Optional\<InputStream>* | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,13 @@
# Connection
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `address` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `local` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the connection is the server's LAN address |
| `port` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `protocol` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `relay` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates the connection is over a relayed connection |
| `uri` | *Optional\<String>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,15 @@
# Country
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `code` | *Optional\<String>* | :heavy_minus_sign: | Three letter code |
| `example` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `flavor` | [Optional\<Flavor>](../../models/operations/Flavor.md) | :heavy_minus_sign: | - `0`: The country is divided into regions, and following the key will lead to a list of regions.<br/>- `1`: The county is divided by postal codes, and an example code is returned in `example`.<br/>- `2`: The country has a single postal code, returned in `example`.<br/> |
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `language` | *Optional\<String>* | :heavy_minus_sign: | Three letter language code |
| `languageTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the language |
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,23 @@
# CreateCollectionRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *String* | :heavy_check_mark: | The section where this collection will be created | |
| `title` | *Optional\<String>* | :heavy_minus_sign: | The title to filter by or assign | |
| `smart` | *Optional\<Boolean>* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
| `uri` | *Optional\<String>* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
| `type` | *Optional\<Long>* | :heavy_minus_sign: | The metadata type to filter by | |

View File

@@ -0,0 +1,11 @@
# CreateCollectionResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `mediaContainerWithMetadata` | [Optional\<MediaContainerWithMetadata>](../../models/shared/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,23 @@
# CreateCustomHubRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *long* | :heavy_check_mark: | The section ID for the hubs to reorder | |
| `metadataItemId` | *long* | :heavy_check_mark: | The metadata item on which to base this hub. This must currently be a collection | |
| `promotedToRecommended` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
| `promotedToOwnHome` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
| `promotedToSharedHome` | [Optional\<BoolInt>](../../models/shared/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |

View File

@@ -0,0 +1,10 @@
# CreateCustomHubResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# CreateDVRRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `accepts` | [Optional\<Accepts>](../../models/shared/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *Optional\<String>* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *Optional\<String>* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *Optional\<String>* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *Optional\<String>* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *Optional\<String>* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `lineup` | *Optional\<String>* | :heavy_minus_sign: | The EPG lineup. | lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT |
| `deviceQueryParameter` | List\<*String*> | :heavy_minus_sign: | The device. | device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA |
| `language` | *Optional\<String>* | :heavy_minus_sign: | The language. | eng |

View File

@@ -0,0 +1,12 @@
# CreateDVRResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<?>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `dvrRequestHandlerSlashGetResponses200` | [Optional\<DvrRequestHandlerSlashGetResponses200>](../../models/shared/DvrRequestHandlerSlashGetResponses200.md) | :heavy_minus_sign: | OK |
| `headers` | Map\<String, List\\<*String*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,17 @@
# CreateDownloadQueueMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A |
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `downloadQueue` | List\<[DownloadQueue](../../models/operations/DownloadQueue.md)> | :heavy_minus_sign: | N/A |

Some files were not shown because too many files have changed in this diff Show More