mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
## 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** ⚠️
This commit is contained in:
speakeasybot
@@ -3,13 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 238960586 |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
||||
| `name` | *Optional\<String>* | :heavy_minus_sign: | N/A | Diane |
|
||||
| `defaultAudioLanguage` | *Optional\<String>* | :heavy_minus_sign: | N/A | en |
|
||||
| `autoSelectAudio` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||
| `defaultSubtitleLanguage` | *Optional\<String>* | :heavy_minus_sign: | N/A | en |
|
||||
| `subtitleMode` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `globalViewCount` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
@@ -1,9 +1,12 @@
|
||||
# Action
|
||||
|
||||
The action to perform for this item on this optimizer queue
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `id` | *String* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||
| `key` | *String* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `REPROCESS` | reprocess |
|
||||
| `DISABLE` | disable |
|
||||
| `ENABLE` | enable |
|
||||
@@ -1,12 +0,0 @@
|
||||
# ActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
@@ -3,13 +3,14 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `uuid` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `cancellable` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A |
|
||||
| `userID` | *Optional\<Double>* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `subtitle` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `progress` | *Optional\<Double>* | :heavy_minus_sign: | N/A |
|
||||
| `context` | [Optional\<Context>](../../models/operations/Context.md) | :heavy_minus_sign: | N/A |
|
||||
| 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 |
|
||||
20
docs/models/operations/AddCollectionItemsRequest.md
Normal file
20
docs/models/operations/AddCollectionItemsRequest.md
Normal 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 | |
|
||||
11
docs/models/operations/AddCollectionItemsResponse.md
Normal file
11
docs/models/operations/AddCollectionItemsResponse.md
Normal 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 |
|
||||
19
docs/models/operations/AddDeviceRequest.md
Normal file
19
docs/models/operations/AddDeviceRequest.md
Normal 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 |
|
||||
11
docs/models/operations/AddDeviceResponse.md
Normal file
11
docs/models/operations/AddDeviceResponse.md
Normal 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 |
|
||||
12
docs/models/operations/AddDeviceToDVRDVR.md
Normal file
12
docs/models/operations/AddDeviceToDVRDVR.md
Normal 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 |
|
||||
17
docs/models/operations/AddDeviceToDVRDVRsMediaContainer.md
Normal file
17
docs/models/operations/AddDeviceToDVRDVRsMediaContainer.md
Normal 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 |
|
||||
9
docs/models/operations/AddDeviceToDVRMediaContainer.md
Normal file
9
docs/models/operations/AddDeviceToDVRMediaContainer.md
Normal 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 |
|
||||
20
docs/models/operations/AddDeviceToDVRRequest.md
Normal file
20
docs/models/operations/AddDeviceToDVRRequest.md
Normal 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. | |
|
||||
12
docs/models/operations/AddDeviceToDVRResponse.md
Normal file
12
docs/models/operations/AddDeviceToDVRResponse.md
Normal 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 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# CreatePlaylistResponseBody
|
||||
# AddDeviceToDVRResponseBody
|
||||
|
||||
returns all playlists
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<CreatePlaylistMediaContainer>](../../models/operations/CreatePlaylistMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<AddDeviceToDVRMediaContainer>](../../models/operations/AddDeviceToDVRMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -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 |
|
||||
@@ -1,85 +1,46 @@
|
||||
# GetRecentlyAddedMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
# AddDownloadQueueItemsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `createdAtAccuracy` | *Optional\<String>* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
|
||||
| `parentStudio` | *String* | :heavy_check_mark: | The studio of the parent media item. | UCP |
|
||||
| `parentTheme` | *String* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||
| `summary` | *String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `type` | [GetRecentlyAddedHubsType](../../models/operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List\<[Director](../../models/operations/Director.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List\<[Writer](../../models/operations/Writer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List\<[Role](../../models/operations/Role.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `rating1` | List\<[Rating](../../models/operations/Rating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| 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 |
|
||||
11
docs/models/operations/AddDownloadQueueItemsResponse.md
Normal file
11
docs/models/operations/AddDownloadQueueItemsResponse.md
Normal 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 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetLibrarySectionsAllResponseBody
|
||||
# AddDownloadQueueItemsResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<GetLibrarySectionsAllMediaContainer>](../../models/operations/GetLibrarySectionsAllMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<AddDownloadQueueItemsMediaContainer>](../../models/operations/AddDownloadQueueItemsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
22
docs/models/operations/AddExtrasRequest.md
Normal file
22
docs/models/operations/AddExtrasRequest.md
Normal 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 | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetTimelineResponse
|
||||
# AddExtrasResponse
|
||||
|
||||
|
||||
## Fields
|
||||
12
docs/models/operations/AddLineupDVR.md
Normal file
12
docs/models/operations/AddLineupDVR.md
Normal 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 |
|
||||
17
docs/models/operations/AddLineupDVRsMediaContainer.md
Normal file
17
docs/models/operations/AddLineupDVRsMediaContainer.md
Normal 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 |
|
||||
@@ -1,10 +1,9 @@
|
||||
# GetStatisticsResponseBody
|
||||
|
||||
Media Statistics
|
||||
# AddLineupMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [Optional\<GetStatisticsMediaContainer>](../../models/operations/GetStatisticsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<AddLineupDVRsMediaContainer>](../../models/operations/AddLineupDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `dvr` | List\<[AddLineupDVR](../../models/operations/AddLineupDVR.md)> | :heavy_minus_sign: | N/A |
|
||||
20
docs/models/operations/AddLineupRequest.md
Normal file
20
docs/models/operations/AddLineupRequest.md
Normal 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 | |
|
||||
12
docs/models/operations/AddLineupResponse.md
Normal file
12
docs/models/operations/AddLineupResponse.md
Normal 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 |
|
||||
@@ -1,12 +1,10 @@
|
||||
# Meta
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
# AddLineupResponseBody
|
||||
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `type` | List\<[GetRecentlyAddedType](../../models/operations/GetRecentlyAddedType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | List\<[GetRecentlyAddedFieldType](../../models/operations/GetRecentlyAddedFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<AddLineupMediaContainer>](../../models/operations/AddLineupMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AddPlaylistContentsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `size` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountAdded` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `leafCountRequested` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `metadata` | List\<[AddPlaylistContentsMetadata](../../models/operations/AddPlaylistContentsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,20 +0,0 @@
|
||||
# AddPlaylistContentsMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 94 |
|
||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /playlists/94/items |
|
||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
|
||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A | playlist |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | A great playlist |
|
||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | N/A | One of my great playlists |
|
||||
| `smart` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||
| `playlistType` | *Optional\<String>* | :heavy_minus_sign: | N/A | video |
|
||||
| `composite` | *Optional\<String>* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
|
||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 423000 |
|
||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `addedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705716458 |
|
||||
| `updatedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705800070 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# AddPlaylistContentsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `playlistID` | *double* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `uri` | *String* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
|
||||
| `playQueueID` | *Optional\<Double>* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
|
||||
21
docs/models/operations/AddPlaylistItemsRequest.md
Normal file
21
docs/models/operations/AddPlaylistItemsRequest.md
Normal 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. | |
|
||||
11
docs/models/operations/AddPlaylistItemsResponse.md
Normal file
11
docs/models/operations/AddPlaylistItemsResponse.md
Normal 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 |
|
||||
19
docs/models/operations/AddProviderRequest.md
Normal file
19
docs/models/operations/AddProviderRequest.md
Normal 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. | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetFileHashResponse
|
||||
# AddProviderResponse
|
||||
|
||||
|
||||
## Fields
|
||||
28
docs/models/operations/AddSectionRequest.md
Normal file
28
docs/models/operations/AddSectionRequest.md
Normal 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 |
|
||||
11
docs/models/operations/AddSectionResponse.md
Normal file
11
docs/models/operations/AddSectionResponse.md
Normal 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 |
|
||||
26
docs/models/operations/AddSubtitlesRequest.md
Normal file
26
docs/models/operations/AddSubtitlesRequest.md
Normal 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 |
|
||||
@@ -1,4 +1,4 @@
|
||||
# LogMultiLineResponse
|
||||
# AddSubtitlesResponse
|
||||
|
||||
|
||||
## Fields
|
||||
22
docs/models/operations/AddToPlayQueueRequest.md
Normal file
22
docs/models/operations/AddToPlayQueueRequest.md
Normal 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 |
|
||||
11
docs/models/operations/AddToPlayQueueResponse.md
Normal file
11
docs/models/operations/AddToPlayQueueResponse.md
Normal 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 |
|
||||
9
docs/models/operations/AddedQueueItems.md
Normal file
9
docs/models/operations/AddedQueueItems.md
Normal 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 |
|
||||
13
docs/models/operations/AdvancedSubtitles.md
Normal file
13
docs/models/operations/AdvancedSubtitles.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# AdvancedSubtitles
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `AUTO` | auto |
|
||||
| `BURN` | burn |
|
||||
| `NONE` | none |
|
||||
| `SIDECAR` | sidecar |
|
||||
| `EMBEDDED` | embedded |
|
||||
| `SEGMENTED` | segmented |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllLibraries
|
||||
|
||||
Indicates if the user has access to all libraries.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllowCameraUpload
|
||||
|
||||
Indicates if the user is allowed to upload from a camera.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllowChannels
|
||||
|
||||
Indicates if the user has access to channels.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllowSubtitleAdmin
|
||||
|
||||
Indicates if the user can manage subtitles.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllowSync
|
||||
|
||||
Indicates if the user is allowed to sync media.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AllowTuners
|
||||
|
||||
Indicates if the user is allowed to use tuners.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
21
docs/models/operations/AnalyzeMetadataRequest.md
Normal file
21
docs/models/operations/AnalyzeMetadataRequest.md
Normal 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 | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# CheckForUpdatesResponse
|
||||
# AnalyzeMetadataResponse
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -3,7 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tonight` | [Optional\<Tonight>](../../models/operations/Tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
||||
| `skip` | [Optional\<Skip>](../../models/operations/Skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |
|
||||
| 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 |
|
||||
@@ -1,4 +1,6 @@
|
||||
# InternalPaymentMethod
|
||||
# Args
|
||||
|
||||
The new values for the metadata item
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,11 +1,9 @@
|
||||
# Attributes
|
||||
|
||||
Attributes associated with the marker.
|
||||
The attributes to assign to this marker
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||
| `version` | *Optional\<Long>* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,11 +0,0 @@
|
||||
# AutoSelectSubtitle
|
||||
|
||||
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
22
docs/models/operations/AutocompleteRequest.md
Normal file
22
docs/models/operations/AutocompleteRequest.md
Normal 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 | |
|
||||
12
docs/models/operations/AutocompleteResponse.md
Normal file
12
docs/models/operations/AutocompleteResponse.md
Normal 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 |
|
||||
10
docs/models/operations/Bandwidth.md
Normal file
10
docs/models/operations/Bandwidth.md
Normal 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 |
|
||||
10
docs/models/operations/Bandwidths.md
Normal file
10
docs/models/operations/Bandwidths.md
Normal 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# Billing
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `internalPaymentMethod` | [InternalPaymentMethod](../../models/operations/InternalPaymentMethod.md) | :heavy_check_mark: | N/A |
|
||||
| `paymentMethodId` | *Optional\<Long>* | :heavy_check_mark: | N/A |
|
||||
@@ -3,11 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `name` | *Optional\<String>* | :heavy_minus_sign: | N/A | BackupDatabase |
|
||||
| `interval` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 3 |
|
||||
| `scheduleRandomized` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `enabled` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | Backup Database |
|
||||
| `description` | *Optional\<String>* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |
|
||||
| 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 |
|
||||
19
docs/models/operations/CancelActivityRequest.md
Normal file
19
docs/models/operations/CancelActivityRequest.md
Normal 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 |
|
||||
10
docs/models/operations/CancelActivityResponse.md
Normal file
10
docs/models/operations/CancelActivityResponse.md
Normal 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 |
|
||||
19
docs/models/operations/CancelGrabRequest.md
Normal file
19
docs/models/operations/CancelGrabRequest.md
Normal 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. | |
|
||||
10
docs/models/operations/CancelGrabResponse.md
Normal file
10
docs/models/operations/CancelGrabResponse.md
Normal 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 |
|
||||
19
docs/models/operations/CancelRefreshRequest.md
Normal file
19
docs/models/operations/CancelRefreshRequest.md
Normal 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 | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# DeleteLibraryResponse
|
||||
# CancelRefreshResponse
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,8 +0,0 @@
|
||||
# CancelServerActivitiesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `activityUUID` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
|
||||
9
docs/models/operations/ChannelMapping.md
Normal file
9
docs/models/operations/ChannelMapping.md
Normal 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 |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
9
docs/models/operations/ChannelMappingByKey.md
Normal file
9
docs/models/operations/ChannelMappingByKey.md
Normal 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 |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -1,15 +0,0 @@
|
||||
# Chapter
|
||||
|
||||
The thumbnail for the chapter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `id` | *long* | :heavy_check_mark: | N/A | 4 |
|
||||
| `filter` | *String* | :heavy_check_mark: | N/A | thumb=4 |
|
||||
| `index` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||
| `startTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
|
||||
| `endTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
|
||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# CheckForUpdatesRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `download` | [Optional\<Download>](../../models/operations/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||
19
docs/models/operations/CheckUpdatesRequest.md
Normal file
19
docs/models/operations/CheckUpdatesRequest.md
Normal 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 |
|
||||
10
docs/models/operations/CheckUpdatesResponse.md
Normal file
10
docs/models/operations/CheckUpdatesResponse.md
Normal 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 |
|
||||
18
docs/models/operations/ChromaSubsampling.md
Normal file
18
docs/models/operations/ChromaSubsampling.md
Normal 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 |
|
||||
10
docs/models/operations/CleanBundlesResponse.md
Normal file
10
docs/models/operations/CleanBundlesResponse.md
Normal 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 |
|
||||
19
docs/models/operations/ClearPlayQueueRequest.md
Normal file
19
docs/models/operations/ClearPlayQueueRequest.md
Normal 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. | |
|
||||
11
docs/models/operations/ClearPlayQueueResponse.md
Normal file
11
docs/models/operations/ClearPlayQueueResponse.md
Normal 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 |
|
||||
19
docs/models/operations/ClearPlaylistItemsRequest.md
Normal file
19
docs/models/operations/ClearPlaylistItemsRequest.md
Normal 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 | |
|
||||
11
docs/models/operations/ClearPlaylistItemsResponse.md
Normal file
11
docs/models/operations/ClearPlaylistItemsResponse.md
Normal 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 |
|
||||
@@ -1,8 +0,0 @@
|
||||
# Collection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
11
docs/models/operations/ComputeChannelMapChannelMapping.md
Normal file
11
docs/models/operations/ComputeChannelMapChannelMapping.md
Normal 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 |
|
||||
17
docs/models/operations/ComputeChannelMapMediaContainer.md
Normal file
17
docs/models/operations/ComputeChannelMapMediaContainer.md
Normal 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 |
|
||||
20
docs/models/operations/ComputeChannelMapRequest.md
Normal file
20
docs/models/operations/ComputeChannelMapRequest.md
Normal 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 | |
|
||||
12
docs/models/operations/ComputeChannelMapResponse.md
Normal file
12
docs/models/operations/ComputeChannelMapResponse.md
Normal 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 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetSessionHistoryResponseBody
|
||||
# ComputeChannelMapResponseBody
|
||||
|
||||
List of Plex Sessions
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [Optional\<GetSessionHistoryMediaContainer>](../../models/operations/GetSessionHistoryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<ComputeChannelMapMediaContainer>](../../models/operations/ComputeChannelMapMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,21 +1,19 @@
|
||||
# GetPinAuthPinContainer
|
||||
|
||||
Requests a new pin id used in the authentication flow
|
||||
# ConnectWebSocketRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *long* | :heavy_check_mark: | N/A | 308667304 |
|
||||
| `code` | *String* | :heavy_check_mark: | N/A | 7RQZ |
|
||||
| `product` | *String* | :heavy_check_mark: | N/A | Tautulli |
|
||||
| `trusted` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
||||
| `qr` | *String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
|
||||
| `clientIdentifier` | *String* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
|
||||
| `location` | [GeoData](../../models/operations/GeoData.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
|
||||
| `expiresIn` | *Optional\<Long>* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
|
||||
| `createdAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
|
||||
| `expiresAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
|
||||
| `authToken` | *JsonNullable\<String>* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `newRegistration` | *JsonNullable\<Object>* | :heavy_minus_sign: | N/A | |
|
||||
| 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/> | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetCompanionsDataResponse
|
||||
# ConnectWebSocketResponse
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@
|
||||
| `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 |
|
||||
| `responseBodies` | List\<[ResponseBody](../../models/operations/ResponseBody.md)> | :heavy_minus_sign: | Companions Data |
|
||||
| `responseStream` | *Optional\<InputStream>* | :heavy_minus_sign: | OK |
|
||||
13
docs/models/operations/Connection.md
Normal file
13
docs/models/operations/Connection.md
Normal 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 |
|
||||
@@ -1,14 +0,0 @@
|
||||
# Connections
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `protocol` | [Protocol](../../models/operations/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
||||
| `address` | *String* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
||||
| `port` | *int* | :heavy_check_mark: | The port used for the connection | |
|
||||
| `uri` | *String* | :heavy_check_mark: | The full URI of the connection | |
|
||||
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
||||
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||
@@ -1,12 +1,15 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||
| 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 |
|
||||
23
docs/models/operations/CreateCollectionRequest.md
Normal file
23
docs/models/operations/CreateCollectionRequest.md
Normal 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 | |
|
||||
11
docs/models/operations/CreateCollectionResponse.md
Normal file
11
docs/models/operations/CreateCollectionResponse.md
Normal 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 |
|
||||
23
docs/models/operations/CreateCustomHubRequest.md
Normal file
23
docs/models/operations/CreateCustomHubRequest.md
Normal 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 |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetResizedPhotoResponse
|
||||
# CreateCustomHubResponse
|
||||
|
||||
|
||||
## Fields
|
||||
21
docs/models/operations/CreateDVRRequest.md
Normal file
21
docs/models/operations/CreateDVRRequest.md
Normal 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 |
|
||||
12
docs/models/operations/CreateDVRResponse.md
Normal file
12
docs/models/operations/CreateDVRResponse.md
Normal 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 |
|
||||
17
docs/models/operations/CreateDownloadQueueMediaContainer.md
Normal file
17
docs/models/operations/CreateDownloadQueueMediaContainer.md
Normal 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 |
|
||||
@@ -1,4 +1,4 @@
|
||||
# AddPlaylistContentsResponse
|
||||
# CreateDownloadQueueResponse
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@
|
||||
| `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\<AddPlaylistContentsResponseBody>](../../models/operations/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||
| `object` | [Optional\<CreateDownloadQueueResponseBody>](../../models/operations/CreateDownloadQueueResponseBody.md) | :heavy_minus_sign: | OK |
|
||||
@@ -1,10 +1,10 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
# CreateDownloadQueueResponseBody
|
||||
|
||||
Playlist Updated
|
||||
OK
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mediaContainer` | [Optional\<AddPlaylistContentsMediaContainer>](../../models/operations/AddPlaylistContentsMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
| `mediaContainer` | [Optional\<CreateDownloadQueueMediaContainer>](../../models/operations/CreateDownloadQueueMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||
23
docs/models/operations/CreateMarkerMediaContainer.md
Normal file
23
docs/models/operations/CreateMarkerMediaContainer.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CreateMarkerMediaContainer
|
||||
|
||||
`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/> |
|
||||
| `color` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `endTimeOffset` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `startTimeOffset` | *Optional\<Long>* | :heavy_minus_sign: | N/A |
|
||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A |
|
||||
| `type` | [Optional\<CreateMarkerType>](../../models/operations/CreateMarkerType.md) | :heavy_minus_sign: | N/A |
|
||||
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A |
|
||||
23
docs/models/operations/CreateMarkerRequest.md
Normal file
23
docs/models/operations/CreateMarkerRequest.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CreateMarkerRequest
|
||||
|
||||
|
||||
## 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 | |
|
||||
| `type` | *long* | :heavy_check_mark: | The type of marker to edit/create | |
|
||||
| `startTimeOffset` | *long* | :heavy_check_mark: | The start time of the marker | |
|
||||
| `endTimeOffset` | *Optional\<Long>* | :heavy_minus_sign: | The end time of the marker | |
|
||||
| `attributes` | [Optional\<Attributes>](../../models/operations/Attributes.md) | :heavy_minus_sign: | The attributes to assign to this marker | {<br/>"title": "My favorite spot"<br/>} |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user