Compare commits

...

4 Commits

Author SHA1 Message Date
speakeasybot
3994020ebb ## Typescript SDK Changes:
* `plex-api.libraryPlaylists.addPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getMetadataHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.moveCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.deleteCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.addCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.butler.stopTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.butler.startTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicPath()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getItemDecision()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getAllHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getContinueWatching()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPromotedHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAllLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPostplayHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getRelatedHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getSectionHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.listContent()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAlbums()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.searchHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.voiceSearchHubs()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryItems()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.ingestTransientItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryMatches()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getMetadataItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getSections()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.addSection()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getTags()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
* `plex-api.content.getCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getAllItemLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.status.listSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.movePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getExtras()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.deletePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.unshuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listMatches()`: 
  *  `request.manual` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.resetPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getRelatedItems()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.clearPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getItemTree()`:  `response.mediacontainer.metadataItem.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.addToPlayQueue()`: 
  *  `request.next` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.getPlayQueue()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.movePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getPerson()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listPersonMedia()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`:  `response.mediacontainer.metadata` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryDetails()`: 
  *  `request.includeDetails` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.modifyPlaylistGenerator()`: 
  *  `request.item` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.autocomplete()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCollections()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCommon()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.deletePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.clearPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.shuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.createPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.collections.createCollection()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.tuneChannel()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getLiveTvSession()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.listPlaylists()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getAllSubscriptions()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.createSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getScheduledRecordings()`:  `response.mediacontainer.mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getTemplate()`:  `response.mediacontainer.subscriptionTemplate.[].mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getSubscription()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.editSubscriptionPreferences()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.reorderSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.makeDecision()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.refreshItemsMetadata()`: 
  *  `request.markUpdated` **Changed**
* `plex-api.authentication.postUsersSignInData()`: **Added**
* `plex-api.transcoder.startTranscodeSession()`:  `request` **Changed**
* `plex-api.devices.modifyDevice()`: 
  *  `request.enabled` **Changed**
* `plex-api.library.getMediaPart()`: 
  *  `request.download` **Changed**
* `plex-api.library.detectIntros()`: 
  *  `request.force` **Changed**
* `plex-api.library.refreshSection()`: 
  *  `request.force` **Changed**
* `plex-api.libraryPlaylists.uploadPlaylist()`: 
  *  `request.force` **Changed**
* `plex-api.library.deleteMediaItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.authentication.getTokenDetails()`: **Added**
* `plex-api.library.getFirstCharacters()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.library.updateItems()`: 
  *  `request.field.locked` **Changed**
* `plex-api.library.deleteLibrarySection()`: 
  *  `request.async` **Changed**
* `plex-api.library.setStreamSelection()`: 
  *  `request.allParts` **Changed**
* `plex-api.playQueue.createPlayQueue()`:  `request` **Changed**
* `plex-api.library.getAugmentationStatus()`: 
  *  `request.wait` **Changed**
* `plex-api.library.detectVoiceActivity()`:  `request` **Changed**
* `plex-api.transcoder.transcodeImage()`:  `request` **Changed**
* `plex-api.transcoder.transcodeSubtitles()`:  `request` **Changed**
* `plex-api.library.addSubtitles()`:  `request` **Changed**
* `plex-api.library.getStream()`: 
  *  `request.autoAdjustSubtitle` **Changed**
* `plex-api.library.startBifGeneration()`: 
  *  `request.force` **Changed**
* `plex-api.library.detectCredits()`:  `request` **Changed**
* `plex-api.ultraBlur.getImage()`: 
  *  `request.noise` **Changed**
* `plex-api.library.generateThumbs()`: 
  *  `request.force` **Changed**
* `plex-api.updater.applyUpdates()`:  `request` **Changed**
* `plex-api.updater.checkUpdates()`: 
  *  `request.download` **Changed**
* `plex-api.library.deleteMetadataItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.library.optimizeDatabase()`: 
  *  `request.async` **Changed**
* `plex-api.hubs.updateHubVisibility()`:  `request` **Changed**
* `plex-api.hubs.createCustomHub()`:  `request` **Changed**
* `plex-api.library.getSectionImage()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.downloadQueue.addDownloadQueueItems()`:  `request` **Changed**
* `plex-api.timeline.report()`:  `request` **Changed**
* `plex-api.general.getSourceConnectionInformation()`: 
  *  `request.refresh` **Changed**
* `plex-api.plex.getServerResources()`: **Added**
* `plex-api.users.getUsers()`: **Added**
2025-12-01 00:15:57 +00:00
speakeasybot
03c047afa2 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.656.1 2025-11-13 00:13:26 +00:00
speakeasybot
03910be91f ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.636.3 2025-10-12 07:28:01 +00:00
speakeasybot
25ed9aa97d ## Typescript SDK Changes Detected:
* `plex-api.general.getServerInfo()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.general.getSourceConnectionInformation()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.general.getTransientToken()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.events.getNotifications()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.events.connectWebSocket()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.preferences.setPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.preferences.getPreference()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.rate.setRating()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.timeline.markPlayed()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.timeline.report()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.timeline.unscrobble()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.activities.cancelActivity()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.butler.stopTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.butler.startTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getDownloadQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.addDownloadQueueItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.listDownloadQueueItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getItemDecision()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getDownloadQueueMedia()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.removeDownloadQueueItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getDownloadQueueItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.restartProcessingDownloadQueueItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getAllHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getContinueWatching()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getHubItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPromotedHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getMetadataHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPostplayHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getRelatedHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getSectionHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.resetSectionDefaults()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.listHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.createCustomHub()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.moveHub()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.deleteCustomHub()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.hubs.updateHubVisibility()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.search.searchHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.search.voiceSearchHubs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.ingestTransientItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryMatches()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.optimizeDatabase()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getRandomArtwork()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.addSection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getSectionsPrefs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.refreshSectionsMetadata()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getTags()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteMetadataItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.editMetadataItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.detectAds()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getAllItemLeaves()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.analyzeMetadata()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.generateThumbs()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.detectCredits()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getExtras()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.addExtras()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getFile()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.startBifGeneration()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.detectIntros()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.createMarker()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.matchItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.listMatches()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.mergeItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.listSonicallySimilar()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.setItemPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.refreshItemsMetadata()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getRelatedItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.listSimilar()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.splitItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.addSubtitles()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getItemTree()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.unmatch()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.listTopUsers()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.detectVoiceActivity()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getAugmentationStatus()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.setStreamSelection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getPerson()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.listPersonMedia()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteLibrarySection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryDetails()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.editSection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.updateItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.startAnalysis()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.autocomplete()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getCollections()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getCommon()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.emptyTrash()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getSectionFilters()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getFirstCharacters()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteIndexes()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteIntros()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getSectionPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.setSectionPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.cancelRefresh()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.refreshSection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getAvailableSorts()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getStreamLevels()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getStreamLoudness()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getChapterImage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.setItemArtwork()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.updateItemArtwork()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteMarker()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.editMarker()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteMediaItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getPartIndex()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteCollection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getSectionImage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.deleteStream()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getStream()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.setStreamOffset()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getItemArtwork()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getMediaPart()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.library.getImageFromBif()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.collections.createCollection()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.createDvr()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.deleteDvr()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.getDvr()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.deleteLineup()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.addLineup()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.setDvrPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.stopDvrReload()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.reloadGuide()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.tuneChannel()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.removeDeviceFromDvr()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.addDeviceToDvr()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.computeChannelMap()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.getChannels()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.getLineup()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.getLineupChannels()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.getCountriesLineups()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.getCountryRegions()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.epg.listLineups()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getLiveTvSession()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getSessionPlaylistIndex()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getSessionSegment()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.log.writeMessage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.log.enablePapertrail()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.getAvailableGrabbers()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.addDevice()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.removeDevice()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.getDeviceDetails()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.modifyDevice()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.setChannelmap()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.getDevicesChannels()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.setDevicePreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.stopScan()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.scan()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.devices.getThumb()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.provider.addProvider()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.provider.deleteMediaProvider()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getAllSubscriptions()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.createSubscription()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getTemplate()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.cancelGrab()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.deleteSubscription()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getSubscription()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.editSubscriptionPreferences()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.reorderSubscription()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.transcodeImage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.makeDecision()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.triggerFallback()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.transcodeSubtitles()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.startTranscodeSession()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playlist.listPlaylists()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylistItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.createPlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.uploadPlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.deletePlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.updatePlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGenerators()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.clearPlaylistItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.addPlaylistItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.deletePlaylistItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGenerator()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.modifyPlaylistGenerator()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.movePlaylistItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.refreshPlaylist()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.createPlayQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.getPlayQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.addToPlayQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.clearPlayQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.resetPlayQueue()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.shuffle()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.unshuffle()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.deletePlayQueueItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.movePlayQueueItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.ultraBlur.getColors()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.ultraBlur.getImage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.status.listPlaybackHistory()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.status.terminateSession()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.status.deleteHistory()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.status.getHistoryItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.updater.applyUpdates()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.updater.checkUpdates()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getCollectionItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getMetadataItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getAlbums()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.listContent()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getAllLeaves()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getArts()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getCategories()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getCluster()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicPath()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getFolders()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.listMoments()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicallySimilar()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getCollectionImage()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.addCollectionItems()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.deleteCollectionItem()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.moveCollectionItem()`:  `request` **Changed** **Breaking** ⚠️
2025-10-12 05:53:52 +00:00
1203 changed files with 49093 additions and 103555 deletions

File diff suppressed because one or more lines are too long

View File

@@ -17,18 +17,23 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
tests:
generateTests: true
generateNewTests: true
skipResponseBodyAssertions: false
typescript:
version: 0.41.0
version: 0.44.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: LukeHagar
baseErrorName: PlexAPIError
clientServerStatusCodesAsErrors: true
@@ -38,8 +43,12 @@ typescript:
enableMCPServer: true
enableReactQuery: false
enumFormat: enum
exportZodModelNamespace: false
flattenGlobalSecurity: true
flatteningOrder: body-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: false
forwardCompatibleUnionsByDefault: "false"
generateExamples: true
imports:
option: openapi
@@ -49,16 +58,21 @@ typescript:
operations: sdk/models/operations
shared: sdk/models/shared
webhooks: sdk/models/webhooks
inferUnionDiscriminators: true
inputModelSuffix: input
jsonpath: legacy
laxMode: strict
maxMethodParams: 4
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: commonjs
multipartArrayFormat: legacy
outputModelSuffix: output
packageName: '@lukehagar/plexjs'
responseFormat: envelope
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
zodVersion: v3

File diff suppressed because one or more lines are too long

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.636.3
speakeasyVersion: 1.665.0
sources:
my-source:
sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257
sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
tags:
- latest
- speakeasy-sdk-regen-1760246702
- speakeasy-sdk-regen-1764548057
- 1.1.1
targets:
plexjs:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257
sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:49b6f9d7cbbdae2b95c455771f7a7e9544fa64695d7326650a4a93a255ba101b
codeSamplesRevisionDigest: sha256:c53f6ae11c517b30d265b87a938e710393ce8921f2f8f5e04f73419faf2ae2f0
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

View File

@@ -20,30 +20,64 @@ specific category of applications.
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { generalGetServerInfo } from "@lukehagar/plexjs/funcs/generalGetServerInfo.js";
import { transcoderStartTranscodeSession } from "@lukehagar/plexjs/funcs/transcoderStartTranscodeSession.js";
import { Extension, StartTranscodeSessionLocation, StartTranscodeSessionProtocol } from "@lukehagar/plexjs/sdk/models/operations";
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/sdk/models/shared";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const res = await generalGetServerInfo(plexAPI, {});
const res = await transcoderStartTranscodeSession(plexAPI, {
transcodeType: TranscodeType.Music,
extension: Extension.Mpd,
advancedSubtitles: AdvancedSubtitles.Burn,
audioBoost: 50,
audioChannelCount: 5,
autoAdjustQuality: BoolInt.True,
autoAdjustSubtitle: BoolInt.True,
directPlay: BoolInt.True,
directStream: BoolInt.True,
directStreamAudio: BoolInt.True,
disableResolutionRotation: BoolInt.True,
hasMDE: BoolInt.True,
location: StartTranscodeSessionLocation.Wan,
mediaBufferSize: 102400,
mediaIndex: 0,
musicBitrate: 5000,
offset: 90.5,
partIndex: 0,
path: "/library/metadata/151671",
peakBitrate: 12000,
photoResolution: "1080x1080",
protocol: StartTranscodeSessionProtocol.Dash,
secondsPerSegment: 5,
subtitleSize: 50,
videoBitrate: 12000,
videoQuality: 50,
videoResolution: "1080x1080",
xPlexClientProfileExtra: "add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
xPlexClientProfileName: "generic",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("generalGetServerInfo failed:", res.error);
console.log("transcoderStartTranscodeSession failed:", res.error);
}
}

329
README.md
View File

@@ -72,22 +72,66 @@ yarn add @lukehagar/plexjs
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/sdk/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.general.getServerInfo({});
const result = await plexAPI.transcoder.startTranscodeSession({
transcodeType: TranscodeType.Music,
extension: Extension.Mpd,
advancedSubtitles: AdvancedSubtitles.Burn,
audioBoost: 50,
audioChannelCount: 5,
autoAdjustQuality: BoolInt.True,
autoAdjustSubtitle: BoolInt.True,
directPlay: BoolInt.True,
directStream: BoolInt.True,
directStreamAudio: BoolInt.True,
disableResolutionRotation: BoolInt.True,
hasMDE: BoolInt.True,
location: StartTranscodeSessionLocation.Wan,
mediaBufferSize: 102400,
mediaIndex: 0,
musicBitrate: 5000,
offset: 90.5,
partIndex: 0,
path: "/library/metadata/151671",
peakBitrate: 12000,
photoResolution: "1080x1080",
protocol: StartTranscodeSessionProtocol.Dash,
secondsPerSegment: 5,
subtitleSize: 50,
videoBitrate: 12000,
videoQuality: 50,
videoResolution: "1080x1080",
xPlexClientProfileExtra:
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
xPlexClientProfileName: "generic",
});
console.log(result);
}
@@ -108,6 +152,11 @@ run();
* [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities
* [cancelActivity](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
### [authentication](docs/sdks/authentication/README.md)
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
### [butler](docs/sdks/butler/README.md)
* [stopTasks](docs/sdks/butler/README.md#stoptasks) - Stop all Butler tasks
@@ -355,6 +404,10 @@ run();
* [deletePlayQueueItem](docs/sdks/playqueue/README.md#deleteplayqueueitem) - Delete an item from a play queue
* [movePlayQueueItem](docs/sdks/playqueue/README.md#moveplayqueueitem) - Move an item in a play queue
### [plex](docs/sdks/plex/README.md)
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
### [preferences](docs/sdks/preferences/README.md)
* [getAllPreferences](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
@@ -424,6 +477,10 @@ run();
* [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates
* [getUpdatesStatus](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of updates
### [users](docs/sdks/users/README.md)
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
</details>
<!-- End Available Resources and Operations [operations] -->
@@ -432,43 +489,54 @@ run();
[`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | ------------------------------------------------------ |
| `error.message` | `string` | Error message |
| `error.statusCode` | `number` | HTTP response status code eg `404` |
| `error.headers` | `Headers` | HTTP response headers |
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
| `error.rawResponse` | `Response` | Raw HTTP response |
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| `error.message` | `string` | Error message |
| `error.statusCode` | `number` | HTTP response status code eg `404` |
| `error.headers` | `Headers` | HTTP response headers |
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
| `error.rawResponse` | `Response` | Raw HTTP response |
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
### Example
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/sdk/models/errors";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
try {
const result = await plexAPI.general.getServerInfo({});
const result = await plexAPI.authentication.getTokenDetails({});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.PlexAPIError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.GetTokenDetailsBadRequestError) {
console.log(error.data$.errors); // GetTokenDetailsBadRequestError[]
console.log(error.data$.rawResponse); // Response
}
}
}
}
@@ -481,7 +549,7 @@ run();
**Primary error:**
* [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts): The base class for HTTP error responses.
<details><summary>Less common errors (6)</summary>
<details><summary>Less common errors (13)</summary>
<br />
@@ -494,9 +562,18 @@ run();
**Inherit from [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts)**:
* [`GetTokenDetailsBadRequestError`](./src/sdk/models/errors/gettokendetailsbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataBadRequestError`](./src/sdk/models/errors/postuserssignindatabadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetUsersBadRequestError`](./src/sdk/models/errors/getusersbadrequesterror.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 241 methods.*
* [`GetTokenDetailsUnauthorizedError`](./src/sdk/models/errors/gettokendetailsunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`PostUsersSignInDataUnauthorizedError`](./src/sdk/models/errors/postuserssignindataunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetUsersUnauthorizedError`](./src/sdk/models/errors/getusersunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`GetServerResourcesUnauthorizedError`](./src/sdk/models/errors/getserverresourcesunauthorizederror.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 241 methods.*
* [`ResponseValidationError`](./src/sdk/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
</details>
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
@@ -510,39 +587,42 @@ You can override the default server globally by passing a server index to the `s
| --- | ---------------------------------------------------------- | -------------------------------------------- | ----------- |
| 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<br/>`port` | |
| 2 | `https://{server_url}` | `server_url` | |
| 2 | `https://{full_server_url}` | `full_server_url` | |
If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
| Variable | Parameter | Default | Description |
| ---------------- | ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `identifier` | `identifier: string` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
| `IP-description` | `ipDescription: string` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
| `port` | `port: string` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
| `protocol` | `protocol: string` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
| `host` | `host: string` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
| `server_url` | `serverUrl: string` | `"http://localhost:32400"` | The full manual URL to access the PMS |
| Variable | Parameter | Default | Description |
| ----------------- | ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `identifier` | `identifier: string` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
| `IP-description` | `ipDescription: string` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
| `port` | `port: string` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
| `protocol` | `protocol: string` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
| `host` | `host: string` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
| `full_server_url` | `fullServerUrl: string` | `"http://localhost:32400"` | The full manual URL to access the PMS |
#### Example
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
serverIdx: 1,
protocol: "<value>",
host: "electric-excess.name",
port: "36393",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
serverIdx: 0,
identifier: "0123456789abcdef0123456789abcdef",
ipDescription: "1-2-3-4",
port: "32400",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
@@ -560,19 +640,22 @@ run();
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
serverURL: "https://http://localhost:32400",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
@@ -583,6 +666,40 @@ async function run() {
run();
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.authentication.getTokenDetails({}, {
serverURL: "https://plex.tv/api/v2",
});
console.log(result);
}
run();
```
<!-- End Server Selection [server] -->
@@ -642,26 +759,28 @@ const sdk = new PlexAPI({ httpClient: httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| -------- | ------ | ------- |
| `apiKey` | apiKey | API key |
| Name | Type | Scheme |
| ------- | ------ | ------- |
| `token` | apiKey | API key |
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
apiKey: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -698,6 +817,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`activitiesCancelActivity`](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
- [`activitiesListActivities`](docs/sdks/activities/README.md#listactivities) - Get all activities
- [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
- [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
- [`butlerGetTasks`](docs/sdks/butler/README.md#gettasks) - Get all Butler tasks
- [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
- [`butlerStartTasks`](docs/sdks/butler/README.md#starttasks) - Start all Butler tasks
@@ -894,6 +1015,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`playQueueResetPlayQueue`](docs/sdks/playqueue/README.md#resetplayqueue) - Reset a play queue
- [`playQueueShuffle`](docs/sdks/playqueue/README.md#shuffle) - Shuffle a play queue
- [`playQueueUnshuffle`](docs/sdks/playqueue/README.md#unshuffle) - Unshuffle a play queue
- [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
- [`preferencesGetAllPreferences`](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
- [`preferencesGetPreference`](docs/sdks/preferences/README.md#getpreference) - Get a preferences
- [`preferencesSetPreferences`](docs/sdks/preferences/README.md#setpreferences) - Set preferences
@@ -933,6 +1055,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Applying updates
- [`updaterCheckUpdates`](docs/sdks/updater/README.md#checkupdates) - Checking for updates
- [`updaterGetUpdatesStatus`](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of updates
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
</details>
<!-- End Standalone functions [standalone-funcs] -->
@@ -955,7 +1078,9 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
import { PlexAPI } from "@lukehagar/plexjs";
import { openAsBlob } from "node:fs";
const plexAPI = new PlexAPI();
const plexAPI = new PlexAPI({
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.log.writeLog(await openAsBlob("example.file"));
@@ -976,18 +1101,21 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
@@ -1014,6 +1142,7 @@ run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
retryConfig: {
@@ -1026,16 +1155,18 @@ const plexAPI = new PlexAPI({
},
retryConnectionErrors: false,
},
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {

View File

@@ -1408,4 +1408,44 @@ Based on:
### Generated
- [typescript v0.41.0] .
### Releases
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
## 2025-10-12 05:51:28
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.42.0] .
### Releases
- [NPM v0.42.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.0 - .
## 2025-10-12 07:25:38
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.42.1] .
### Releases
- [NPM v0.42.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.1 - .
## 2025-11-13 00:11:23
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.656.1 (2.753.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.43.0] .
### Releases
- [NPM v0.43.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.43.0 - .
## 2025-12-01 00:13:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.665.0 (2.767.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.44.0] .
### Releases
- [NPM v0.44.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.44.0 - .

View File

@@ -1,22 +1,66 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/sdk/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.general.getServerInfo({});
const result = await plexAPI.transcoder.startTranscodeSession({
transcodeType: TranscodeType.Music,
extension: Extension.Mpd,
advancedSubtitles: AdvancedSubtitles.Burn,
audioBoost: 50,
audioChannelCount: 5,
autoAdjustQuality: BoolInt.True,
autoAdjustSubtitle: BoolInt.True,
directPlay: BoolInt.True,
directStream: BoolInt.True,
directStreamAudio: BoolInt.True,
disableResolutionRotation: BoolInt.True,
hasMDE: BoolInt.True,
location: StartTranscodeSessionLocation.Wan,
mediaBufferSize: 102400,
mediaIndex: 0,
musicBitrate: 5000,
offset: 90.5,
partIndex: 0,
path: "/library/metadata/151671",
peakBitrate: 12000,
photoResolution: "1080x1080",
protocol: StartTranscodeSessionProtocol.Dash,
secondsPerSegment: 5,
subtitleSize: 50,
videoBitrate: 12000,
videoQuality: 50,
videoResolution: "1080x1080",
xPlexClientProfileExtra:
"add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
xPlexClientProfileName: "generic",
});
console.log(result);
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,18 @@
# GetServerResourcesUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetServerResourcesUnauthorizedError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetServerResourcesError](../../../sdk/models/operations/getserverresourceserror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetTokenDetailsBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetTokenDetailsBadRequestError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetTokenDetailsBadRequestError](../../../sdk/models/operations/gettokendetailsbadrequesterror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetTokenDetailsUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetTokenDetailsUnauthorizedError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetTokenDetailsUnauthorizedError](../../../sdk/models/operations/gettokendetailsunauthorizederror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetUsersBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetUsersBadRequestError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetUsersBadRequestError](../../../sdk/models/operations/getusersbadrequesterror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetUsersUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetUsersUnauthorizedError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetUsersUnauthorizedError](../../../sdk/models/operations/getusersunauthorizederror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# PostUsersSignInDataBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { PostUsersSignInDataBadRequestError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataBadRequestError](../../../sdk/models/operations/postuserssignindatabadrequesterror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# PostUsersSignInDataUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { PostUsersSignInDataUnauthorizedError } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataUnauthorizedError](../../../sdk/models/operations/postuserssignindataunauthorizederror.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -6,16 +6,16 @@
import { AddCollectionItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddCollectionItemsGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddCollectionItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,15 +15,16 @@ let value: AddCollectionItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `collectionId` | *number* | :heavy_check_mark: | The collection id | |
| `uri` | *string* | :heavy_check_mark: | The URI describing the items to add to this collection | |

View File

@@ -6,16 +6,16 @@
import { AddDeviceGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddDeviceGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddDeviceGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: AddDeviceRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `uri` | *string* | :heavy_minus_sign: | The URI of the device. | http://10.0.0.5 |

View File

@@ -6,16 +6,16 @@
import { AddDeviceToDVRGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddDeviceToDVRGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddDeviceToDVRGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,15 +15,16 @@ let value: AddDeviceToDVRRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `dvrId` | *number* | :heavy_check_mark: | The ID of the DVR. | |
| `deviceId` | *number* | :heavy_check_mark: | The ID of the device to add. | |

View File

@@ -6,16 +6,16 @@
import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddDownloadQueueItemsGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddDownloadQueueItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -4,7 +4,7 @@
```typescript
import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { AdvancedSubtitles, BoolInt, LocationParameter, Protocol, Subtitles } from "@lukehagar/plexjs/sdk/models/shared";
import { AdvancedSubtitles, BoolInt, LocationParameter, ProtocolParameter, Subtitles } from "@lukehagar/plexjs/sdk/models/shared";
let value: AddDownloadQueueItemsRequest = {
queueId: 44894,
@@ -15,13 +15,13 @@ let value: AddDownloadQueueItemsRequest = {
advancedSubtitles: AdvancedSubtitles.Burn,
audioBoost: 50,
audioChannelCount: 5,
autoAdjustQuality: BoolInt.One,
autoAdjustSubtitle: BoolInt.One,
directPlay: BoolInt.One,
directStream: BoolInt.One,
directStreamAudio: BoolInt.One,
disableResolutionRotation: BoolInt.One,
hasMDE: BoolInt.One,
autoAdjustQuality: BoolInt.True,
autoAdjustSubtitle: BoolInt.True,
directPlay: BoolInt.True,
directStream: BoolInt.True,
directStreamAudio: BoolInt.True,
disableResolutionRotation: BoolInt.True,
hasMDE: BoolInt.True,
location: LocationParameter.Wan,
mediaBufferSize: 102400,
mediaIndex: 0,
@@ -31,7 +31,7 @@ let value: AddDownloadQueueItemsRequest = {
path: "/library/metadata/151671",
peakBitrate: 12000,
photoResolution: "1080x1080",
protocol: Protocol.Dash,
protocol: ProtocolParameter.Dash,
secondsPerSegment: 5,
subtitleSize: 50,
subtitles: Subtitles.Sidecar,
@@ -45,16 +45,17 @@ let value: AddDownloadQueueItemsRequest = {
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `queueId` | *number* | :heavy_check_mark: | The queue id | |
| `keys` | *string*[] | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../../sdk/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 |
@@ -76,7 +77,7 @@ let value: AddDownloadQueueItemsRequest = {
| `path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
| `peakBitrate` | *number* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
| `photoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
| `protocol` | [shared.Protocol](../../../sdk/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 |
| `protocol` | [shared.ProtocolParameter](../../../sdk/models/shared/protocolparameter.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` | *number* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
| `subtitleSize` | *number* | :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` | [shared.Subtitles](../../../sdk/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 |

View File

@@ -6,16 +6,16 @@
import { AddExtrasGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddExtrasGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddExtrasGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,16 +15,17 @@ let value: AddExtrasRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `extraType` | *number* | :heavy_minus_sign: | The metadata type of the extra | |
| `url` | *string* | :heavy_check_mark: | The URL of the extra | |

View File

@@ -6,16 +6,16 @@
import { AddLineupGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddLineupGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddLineupGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,15 +15,16 @@ let value: AddLineupRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `dvrId` | *number* | :heavy_check_mark: | The ID of the DVR. | |
| `lineup` | *string* | :heavy_check_mark: | The lineup to delete | |

View File

@@ -6,16 +6,16 @@
import { AddPlaylistItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistItemsGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddPlaylistItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,16 +14,17 @@ let value: AddPlaylistItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playlistId` | *number* | :heavy_check_mark: | The ID of the playlist | |
| `uri` | *string* | :heavy_minus_sign: | The content URI for the playlist. | |
| `playQueueID` | *number* | :heavy_minus_sign: | The play queue to add to a playlist. | |

View File

@@ -6,16 +6,16 @@
import { AddProviderGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddProviderGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddProviderGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: AddProviderRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `url` | *string* | :heavy_check_mark: | The URL of the media provider to add. | |

View File

@@ -6,16 +6,16 @@
import { AddSectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddSectionGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddSectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -16,8 +16,8 @@ let value: AddSectionRequest = {
"O:\fatboy\\Media\\My Music",
],
prefs: {},
relative: BoolInt.One,
importFromiTunes: BoolInt.One,
relative: BoolInt.True,
importFromiTunes: BoolInt.True,
};
```
@@ -25,16 +25,17 @@ let value: AddSectionRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *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` | *number* | :heavy_check_mark: | The type of library section | |
| `scanner` | *string* | :heavy_minus_sign: | The scanner this section should use | |

View File

@@ -6,16 +6,16 @@
import { AddSubtitlesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddSubtitlesGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddSubtitlesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -8,8 +8,8 @@ import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: AddSubtitlesRequest = {
ids: "<value>",
forced: BoolInt.One,
hearingImpaired: BoolInt.One,
forced: BoolInt.True,
hearingImpaired: BoolInt.True,
};
```
@@ -17,16 +17,17 @@ let value: AddSubtitlesRequest = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `title` | *string* | :heavy_minus_sign: | N/A | |
| `language` | *string* | :heavy_minus_sign: | N/A | |

View File

@@ -6,16 +6,16 @@
import { AddToPlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddToPlayQueueGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AddToPlayQueueGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -8,7 +8,7 @@ import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: AddToPlayQueueRequest = {
playQueueId: 354193,
next: BoolInt.One,
next: BoolInt.True,
};
```
@@ -16,16 +16,17 @@ let value: AddToPlayQueueRequest = {
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playQueueId` | *number* | :heavy_check_mark: | The ID of the play queue. | |
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
| `playlistID` | *string* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |

View File

@@ -0,0 +1,18 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Example Usage
```typescript
import { AllLibraries } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllLibraries = AllLibraries.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Example Usage
```typescript
import { AllowCameraUpload } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowCameraUpload = AllowCameraUpload.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowChannels
Indicates if the user has access to channels.
## Example Usage
```typescript
import { AllowChannels } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowChannels = AllowChannels.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Example Usage
```typescript
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Example Usage
```typescript
import { AllowSync } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowSync = AllowSync.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Example Usage
```typescript
import { AllowTuners } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowTuners = AllowTuners.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -6,16 +6,16 @@
import { AnalyzeMetadataGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AnalyzeMetadataGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AnalyzeMetadataGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,16 +14,17 @@ let value: AnalyzeMetadataRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `thumbOffset` | *number* | :heavy_minus_sign: | Set the offset to be used for thumbnails | |
| `artOffset` | *number* | :heavy_minus_sign: | Set the offset to be used for artwork | |

View File

@@ -6,16 +6,16 @@
import { ApplyUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: ApplyUpdatesGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: ApplyUpdatesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -7,8 +7,8 @@ import { ApplyUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: ApplyUpdatesRequest = {
tonight: BoolInt.One,
skip: BoolInt.One,
tonight: BoolInt.True,
skip: BoolInt.True,
};
```
@@ -16,15 +16,16 @@ let value: ApplyUpdatesRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `tonight` | [shared.BoolInt](../../../sdk/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` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |

View File

@@ -6,16 +6,16 @@
import { AutocompleteGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: AutocompleteGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: AutocompleteGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -4,27 +4,34 @@
```typescript
import { AutocompleteRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { MediaType } from "@lukehagar/plexjs/sdk/models/shared";
let value: AutocompleteRequest = {
sectionId: 594987,
mediaQuery: {
type: MediaType.Episode,
sourceType: 2,
sort: "duration:desc,index",
},
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
| `type` | *number* | :heavy_minus_sign: | Item type | |
| `fieldQuery` | *string* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
| `mediaQuery` | [shared.MediaQuery](../../../sdk/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 | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
| `type` | *number* | :heavy_minus_sign: | Item type | |
| `fieldQuery` | *string* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
| `mediaQuery` | [shared.MediaQuery](../../../sdk/models/shared/mediaquery.md) | :heavy_minus_sign: | A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic.<br/><br/>The query supports:<br/>- Fields: integer, boolean, tag, string, date, language<br/>- Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type)<br/>- Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR)<br/>- Sorting: sort parameter with :desc, :nullsLast modifiers<br/>- Grouping: group parameter<br/>- Limits: limit parameter<br/><br/>Examples:<br/>- Object format: `{type: 4, sourceType: 2, title: "24"}``type=4&sourceType=2&title=24`<br/>- String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24"<br/>- Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10<br/><br/>See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.<br/> | {<br/>"type": 4,<br/>"sourceType": 2,<br/>"sort": "duration:desc,index"<br/>} |

View File

@@ -0,0 +1,19 @@
# Billing
## Example Usage
```typescript
import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
let value: Billing = {
internalPaymentMethod: {},
paymentMethodId: 575569,
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `internalPaymentMethod` | [operations.InternalPaymentMethod](../../../sdk/models/operations/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
| `paymentMethodId` | *number* | :heavy_check_mark: | N/A |

View File

@@ -10,6 +10,6 @@ let value: ButlerTasks = {};
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `butlerTask` | [operations.ButlerTask](../../../sdk/models/operations/butlertask.md)[] | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `butlerTask` | [operations.GetTasksButlerTask](../../../sdk/models/operations/gettasksbutlertask.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -6,16 +6,16 @@
import { CancelActivityGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CancelActivityGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CancelActivityGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: CancelActivityRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `activityId` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e |

View File

@@ -6,16 +6,16 @@
import { CancelGrabGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CancelGrabGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CancelGrabGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: CancelGrabRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `operationId` | *string* | :heavy_check_mark: | The ID of the operation. | |

View File

@@ -6,16 +6,16 @@
import { CancelRefreshGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CancelRefreshGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CancelRefreshGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: CancelRefreshRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |

View File

@@ -6,16 +6,16 @@
import { CheckUpdatesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CheckUpdatesGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CheckUpdatesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -7,7 +7,7 @@ import { CheckUpdatesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: CheckUpdatesRequest = {
download: BoolInt.One,
download: BoolInt.True,
};
```
@@ -15,14 +15,15 @@ let value: CheckUpdatesRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `download` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -6,16 +6,16 @@
import { ClearPlaylistItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: ClearPlaylistItemsGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: ClearPlaylistItemsGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: ClearPlaylistItemsRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playlistId` | *number* | :heavy_check_mark: | The ID of the playlist | |

View File

@@ -6,16 +6,16 @@
import { ClearPlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: ClearPlayQueueGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: ClearPlayQueueGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: ClearPlayQueueRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `playQueueId` | *number* | :heavy_check_mark: | The ID of the play queue. | |

View File

@@ -6,16 +6,16 @@
import { ComputeChannelMapGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: ComputeChannelMapGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: ComputeChannelMapGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -6,7 +6,7 @@
import { ComputeChannelMapRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: ComputeChannelMapRequest = {
device: "Desktop",
deviceQueryParameter: "<value>",
lineup: "<value>",
};
```
@@ -15,15 +15,16 @@ let value: ComputeChannelMapRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `device` | *string* | :heavy_check_mark: | The URI describing the device | |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `deviceQueryParameter` | *string* | :heavy_check_mark: | The URI describing the device | |
| `lineup` | *string* | :heavy_check_mark: | The URI describing the lineup | |

View File

@@ -6,16 +6,16 @@
import { ConnectWebSocketGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: ConnectWebSocketGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: ConnectWebSocketGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -12,14 +12,15 @@ let value: ConnectWebSocketRequest = {};
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `filter` | *string*[] | :heavy_minus_sign: | By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:<br/><br/>- `filters=-log`: All event types except logs (the default).<br/>- `filters=foo,bar`: Only the foo and bar event types.<br/>- `filters=`: All events types.<br/>- `filters=-foo,bar`: All event types except foo and bar.<br/> | |

View File

@@ -6,16 +6,16 @@
import { CreateCollectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateCollectionGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreateCollectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -4,28 +4,31 @@
```typescript
import { CreateCollectionRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { MediaType } from "@lukehagar/plexjs/sdk/models/shared";
let value: CreateCollectionRequest = {
sectionId: "<id>",
type: MediaType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *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` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
| `smart` | *boolean* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
| `uri` | *string* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
| `type` | *number* | :heavy_minus_sign: | The metadata type to filter by | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *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` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
| `smart` | *boolean* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
| `uri` | *string* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
| `type` | [shared.MediaType](../../../sdk/models/shared/mediatype.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -6,16 +6,16 @@
import { CreateCustomHubGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateCustomHubGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreateCustomHubGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -9,9 +9,9 @@ import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: CreateCustomHubRequest = {
sectionId: 94028,
metadataItemId: 822624,
promotedToRecommended: BoolInt.One,
promotedToOwnHome: BoolInt.One,
promotedToSharedHome: BoolInt.One,
promotedToRecommended: BoolInt.True,
promotedToOwnHome: BoolInt.True,
promotedToSharedHome: BoolInt.True,
};
```
@@ -19,16 +19,17 @@ let value: CreateCustomHubRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | The section ID for the hubs to reorder | |
| `metadataItemId` | *number* | :heavy_check_mark: | The metadata item on which to base this hub. This must currently be a collection | |
| `promotedToRecommended` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |

View File

@@ -6,16 +6,16 @@
import { CreateDVRGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateDVRGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreateDVRGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -7,7 +7,7 @@ import { CreateDVRRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateDVRRequest = {
lineup: "lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT",
device: [
deviceQueryParameter: [
"device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA",
],
language: "eng",
@@ -18,16 +18,17 @@ let value: CreateDVRRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `lineup` | *string* | :heavy_minus_sign: | The EPG lineup. | lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT |
| `device` | *string*[] | :heavy_minus_sign: | The device. | device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA |
| `deviceQueryParameter` | *string*[] | :heavy_minus_sign: | The device. | device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA |
| `language` | *string* | :heavy_minus_sign: | The language. | eng |

View File

@@ -6,16 +6,16 @@
import { CreateMarkerGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateMarkerGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreateMarkerGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -17,16 +17,17 @@ let value: CreateMarkerRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `type` | *number* | :heavy_check_mark: | The type of marker to edit/create | |
| `startTimeOffset` | *number* | :heavy_check_mark: | The start time of the marker | |

View File

@@ -6,16 +6,16 @@
import { CreatePlaylistGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreatePlaylistGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -12,15 +12,16 @@ let value: CreatePlaylistRequest = {};
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're playing (e.g. `library://...`). | |
| `playQueueID` | *number* | :heavy_minus_sign: | To create a playlist from an existing play queue. | |

View File

@@ -6,16 +6,16 @@
import { CreatePlayQueueGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlayQueueGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreatePlayQueueGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -8,11 +8,11 @@ import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: CreatePlayQueueRequest = {
type: CreatePlayQueueType.Audio,
shuffle: BoolInt.One,
repeat: BoolInt.One,
continuous: BoolInt.One,
recursive: BoolInt.One,
onDeck: BoolInt.One,
shuffle: BoolInt.True,
repeat: BoolInt.True,
continuous: BoolInt.True,
recursive: BoolInt.True,
onDeck: BoolInt.True,
};
```
@@ -20,16 +20,17 @@ let value: CreatePlayQueueRequest = {
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're playing. | |
| `playlistID` | *number* | :heavy_minus_sign: | the ID of the playlist we're playing. | |
| `type` | [operations.CreatePlayQueueType](../../../sdk/models/operations/createplayqueuetype.md) | :heavy_check_mark: | The type of play queue to create | |

View File

@@ -6,16 +6,16 @@
import { CreateSubscriptionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreateSubscriptionGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: CreateSubscriptionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -9,6 +9,7 @@ The container often "hoists" common attributes from its children. For example, i
```typescript
import { CreateSubscriptionMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: CreateSubscriptionMediaContainer = {
mediaSubscription: [
@@ -16,9 +17,14 @@ let value: CreateSubscriptionMediaContainer = {
mediaGrabOperation: [
{
metadata: {
title: "<value>",
type: "<value>",
addedAt: 3539,
art: "/library/metadata/58683/art/1703239236",
autotag: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -26,9 +32,12 @@ let value: CreateSubscriptionMediaContainer = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
chapterSource: "media",
childCount: 1,
country: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -39,6 +48,7 @@ let value: CreateSubscriptionMediaContainer = {
director: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -49,6 +59,7 @@ let value: CreateSubscriptionMediaContainer = {
genre: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -56,16 +67,16 @@ let value: CreateSubscriptionMediaContainer = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
guid: [
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
guid: "plex://movie/5d7768ba96b655001fdc0408",
guids: [
{
filter: "actor=49",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
id:
"{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
},
],
key: "<key>",
lastViewedAt: 1556281940,
media: [
{
aspectRatio: 2.35,
@@ -82,46 +93,72 @@ let value: CreateSubscriptionMediaContainer = {
optimizedForStreaming: false,
part: [
{
accessible: true,
audioProfile: "lc",
container: "mov",
duration: 150192,
exists: true,
file:
"/home/schuyler/Videos/Trailers/Cloud Atlas (2012).mov",
has64bitOffsets: false,
id: 1,
indexes: "sd",
key: "/library/parts/1/1531779263/file.mov",
optimizedForStreaming: false,
size: 105355654,
stream: [
{
default: true,
audioChannelLayout: "stereo",
bitDepth: 8,
bitrate: 5466,
canAutoSync: true,
audioChannelLayout: "5.1(side)",
channels: 6,
bitDepth: 10,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitrate: 24743,
canAutoSync: false,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codec: "h264",
colorPrimaries: "bt709",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
codec: "hevc",
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
displayTitle: "English (H.264 Main)",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
frameRate: 23.976,
hasScalingMatrix: false,
height: 544,
id: 1,
height: 1602,
id: 1002625,
index: 0,
key: "/library/streams/1",
key: "/library/streams/216389",
language: "English",
languageCode: "eng",
level: 31,
profile: "main",
refFrames: 2,
languageTag: "en",
format: "srt",
headerCompression: true,
level: 150,
original: true,
profile: "main 10",
refFrames: 1,
samplingRate: 48000,
scanType: "progressive",
embeddedInVideo: "progressive",
selected: true,
forced: true,
hearingImpaired: true,
dub: true,
title: "SDH",
streamIdentifier: 1,
streamType: 1,
width: 1280,
width: 3840,
},
],
videoProfile: "main",
@@ -134,9 +171,12 @@ let value: CreateSubscriptionMediaContainer = {
width: 1280,
},
],
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
ratingArray: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -147,6 +187,7 @@ let value: CreateSubscriptionMediaContainer = {
role: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -154,9 +195,12 @@ let value: CreateSubscriptionMediaContainer = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
writer: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",

View File

@@ -19,16 +19,17 @@ let value: CreateSubscriptionRequest = {
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `targetLibrarySectionID` | *number* | :heavy_minus_sign: | The library section into which we'll grab the media. Not actually required when the subscription is to a playlist. | 1 |
| `targetSectionLocationID` | *number* | :heavy_minus_sign: | The section location into which to grab. | 3 |
| `type` | *number* | :heavy_minus_sign: | The type of the thing we're subscribing too (e.g. show, season). | 2 |

View File

@@ -6,6 +6,7 @@ OK
```typescript
import { CreateSubscriptionResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: CreateSubscriptionResponseBody = {
mediaContainer: {
@@ -14,9 +15,14 @@ let value: CreateSubscriptionResponseBody = {
mediaGrabOperation: [
{
metadata: {
title: "<value>",
type: "<value>",
addedAt: 3539,
art: "/library/metadata/58683/art/1703239236",
autotag: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -24,9 +30,12 @@ let value: CreateSubscriptionResponseBody = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
chapterSource: "media",
childCount: 1,
country: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -37,6 +46,7 @@ let value: CreateSubscriptionResponseBody = {
director: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -47,6 +57,7 @@ let value: CreateSubscriptionResponseBody = {
genre: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -54,16 +65,16 @@ let value: CreateSubscriptionResponseBody = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
guid: [
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
guid: "plex://movie/5d7768ba96b655001fdc0408",
guids: [
{
filter: "actor=49",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
id:
"{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
},
],
key: "<key>",
lastViewedAt: 1556281940,
media: [
{
aspectRatio: 2.35,
@@ -80,46 +91,72 @@ let value: CreateSubscriptionResponseBody = {
optimizedForStreaming: false,
part: [
{
accessible: true,
audioProfile: "lc",
container: "mov",
duration: 150192,
exists: true,
file:
"/home/schuyler/Videos/Trailers/Cloud Atlas (2012).mov",
has64bitOffsets: false,
id: 1,
indexes: "sd",
key: "/library/parts/1/1531779263/file.mov",
optimizedForStreaming: false,
size: 105355654,
stream: [
{
default: true,
audioChannelLayout: "stereo",
bitDepth: 8,
bitrate: 5466,
canAutoSync: true,
audioChannelLayout: "5.1(side)",
channels: 6,
bitDepth: 10,
doviblCompatID: 1,
doviblPresent: true,
dovielPresent: false,
doviLevel: 6,
doviPresent: true,
doviProfile: 8,
dovirpuPresent: true,
doviVersion: "1.0",
bitrate: 24743,
canAutoSync: false,
chromaLocation: "topleft",
chromaSubsampling: "4:2:0",
codec: "h264",
colorPrimaries: "bt709",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
codec: "hevc",
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
displayTitle: "English (H.264 Main)",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
frameRate: 23.976,
hasScalingMatrix: false,
height: 544,
id: 1,
height: 1602,
id: 1002625,
index: 0,
key: "/library/streams/1",
key: "/library/streams/216389",
language: "English",
languageCode: "eng",
level: 31,
profile: "main",
refFrames: 2,
languageTag: "en",
format: "srt",
headerCompression: true,
level: 150,
original: true,
profile: "main 10",
refFrames: 1,
samplingRate: 48000,
scanType: "progressive",
embeddedInVideo: "progressive",
selected: true,
forced: true,
hearingImpaired: true,
dub: true,
title: "SDH",
streamIdentifier: 1,
streamType: 1,
width: 1280,
width: 3840,
},
],
videoProfile: "main",
@@ -132,9 +169,12 @@ let value: CreateSubscriptionResponseBody = {
width: 1280,
},
],
originallyAvailableAt: new RFCDate("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
ratingArray: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -145,6 +185,7 @@ let value: CreateSubscriptionResponseBody = {
role: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
@@ -152,9 +193,12 @@ let value: CreateSubscriptionResponseBody = {
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
theme: "/library/metadata/1/theme/1705636920",
thumb: "/library/metadata/58683/thumb/1703239236",
writer: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",

View File

@@ -6,16 +6,16 @@
import { DeleteCollectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteCollectionGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteCollectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -6,16 +6,16 @@
import { DeleteCollectionItemGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteCollectionItemGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteCollectionItemGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,15 +15,16 @@ let value: DeleteCollectionItemRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `collectionId` | *number* | :heavy_check_mark: | The collection id | |
| `itemId` | *number* | :heavy_check_mark: | The item to delete | |

View File

@@ -15,15 +15,16 @@ let value: DeleteCollectionRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
| `collectionId` | *number* | :heavy_check_mark: | Collection Id | |

View File

@@ -6,16 +6,16 @@
import { DeleteCustomHubGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteCustomHubGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteCustomHubGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -15,15 +15,16 @@ let value: DeleteCustomHubRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | The section ID for the hubs to change | |
| `identifier` | *string* | :heavy_check_mark: | The identifier of the hub to change | |

View File

@@ -6,16 +6,16 @@
import { DeleteDVRGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteDVRGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteDVRGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: DeleteDVRRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `dvrId` | *number* | :heavy_check_mark: | The ID of the DVR. | |

View File

@@ -6,16 +6,16 @@
import { DeleteHistoryGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteHistoryGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteHistoryGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: DeleteHistoryRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `historyId` | *number* | :heavy_check_mark: | The id of the history item (the `historyKey` from above) | |

View File

@@ -6,16 +6,16 @@
import { DeleteIndexesGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteIndexesGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteIndexesGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: DeleteIndexesRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |

View File

@@ -6,16 +6,16 @@
import { DeleteIntrosGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteIntrosGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteIntrosGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -14,14 +14,15 @@ let value: DeleteIntrosRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |

View File

@@ -6,16 +6,16 @@
import { DeleteLibrarySectionGlobals } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteLibrarySectionGlobals = {
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
};
```
@@ -23,13 +23,14 @@ let value: DeleteLibrarySectionGlobals = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |

View File

@@ -8,7 +8,7 @@ import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
let value: DeleteLibrarySectionRequest = {
sectionId: "<id>",
async: BoolInt.One,
async: BoolInt.True,
};
```
@@ -16,15 +16,16 @@ let value: DeleteLibrarySectionRequest = {
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `sectionId` | *string* | :heavy_check_mark: | The section identifier | |
| `async` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | If set, response will return an activity with the actual deletion process. Otherwise request will return when deletion is complete | 1 |

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