Compare commits

...

8 Commits

Author SHA1 Message Date
speakeasybot
4f27055ae6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.665.0 2025-12-01 01:50:09 +00:00
Luke Hagar
956c980d8b Update gen.yaml 2025-11-30 19:47:18 -06:00
Luke Hagar
8fdf3a4385 Update gen.yaml 2025-11-30 19:25:24 -06:00
Luke Hagar
0830add9f3 Update gen.yaml 2025-11-30 19:17:08 -06:00
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
2235 changed files with 107211 additions and 171229 deletions

File diff suppressed because one or more lines are too long

View File

@@ -17,48 +17,62 @@ generation:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
hoistGlobalSecurity: true hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
tests: tests:
generateTests: true generateTests: true
generateNewTests: true generateNewTests: true
skipResponseBodyAssertions: false skipResponseBodyAssertions: false
typescript: typescript:
version: 0.41.0 version: 0.44.1
acceptHeaderEnum: true acceptHeaderEnum: true
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}
peerDependencies: {} peerDependencies: {}
additionalPackageJSON: {} additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: LukeHagar author: LukeHagar
baseErrorName: PlexAPIError baseErrorName: PlexAPIError
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: true constFieldsAlwaysOptional: true
defaultErrorName: SDKError defaultErrorName: SDKError
enableCustomCodeRegions: false enableCustomCodeRegions: false
enableMCPServer: true enableMCPServer: false
enableReactQuery: false enableReactQuery: false
enumFormat: enum enumFormat: enum
exportZodModelNamespace: false
flattenGlobalSecurity: true flattenGlobalSecurity: true
flatteningOrder: body-first flatteningOrder: body-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: true
forwardCompatibleUnionsByDefault: tagged-only
generateExamples: true generateExamples: true
imports: imports:
option: openapi option: openapi
paths: paths:
callbacks: sdk/models/callbacks callbacks: models/callbacks
errors: sdk/models/errors errors: models/errors
operations: sdk/models/operations operations: models/operations
shared: sdk/models/shared shared: models/shared
webhooks: sdk/models/webhooks webhooks: models/webhooks
inferUnionDiscriminators: true
inputModelSuffix: input inputModelSuffix: input
jsonpath: legacy jsonpath: rfc9535
laxMode: lax
maxMethodParams: 4 maxMethodParams: 4
methodArguments: require-security-and-request methodArguments: require-security-and-request
modelPropertyCasing: camel modelPropertyCasing: camel
moduleFormat: commonjs moduleFormat: commonjs
multipartArrayFormat: legacy
outputModelSuffix: output outputModelSuffix: output
packageName: '@lukehagar/plexjs' packageName: '@lukehagar/plexjs'
responseFormat: envelope responseFormat: flat
sseFlatResponse: false sseFlatResponse: false
templateVersion: v2 templateVersion: v2
unionStrategy: populated-fields
usageSDKInitImports: [] usageSDKInitImports: []
useIndexModules: true useIndexModules: true
zodVersion: v4

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: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135 sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257 sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1760246702 - speakeasy-sdk-regen-1764553715
- 1.1.1 - 1.1.1
targets: targets:
plexjs: plexjs:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135 sourceRevisionDigest: sha256:ace004a3b232e8ab9ca3d89f2da8e40470236e6d997073a16c3f8872d67a7383
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257 sourceBlobDigest: sha256:993bfb796a3833b0a3b813ad12469ca34db94f23c2d15ae988a26b4d1ed80fbe
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:49b6f9d7cbbdae2b95c455771f7a7e9544fa64695d7326650a4a93a255ba101b codeSamplesRevisionDigest: sha256:8e6f77ee0be9e54c36682ee6244983f9a69ce9a05a6a251f64df3f5fbd5bc08a
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

View File

@@ -20,30 +20,64 @@ specific category of applications.
```typescript ```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js"; 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/models/operations";
import { Accepts, AdvancedSubtitles, BoolInt, TranscodeType } from "@lukehagar/plexjs/models/shared";
// Use `PlexAPICore` for best tree-shaking performance. // Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application. // You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({ const plexAPI = new PlexAPICore({
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { 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) { if (res.ok) {
const { value: result } = res; const { value: result } = res;
console.log(result); console.log(result);
} else { } else {
console.log("generalGetServerInfo failed:", res.error); console.log("transcoderStartTranscodeSession failed:", res.error);
} }
} }

326
README.md
View File

@@ -72,22 +72,66 @@ yarn add @lukehagar/plexjs
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { 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); console.log(result);
} }
@@ -108,6 +152,11 @@ run();
* [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities * [listActivities](docs/sdks/activities/README.md#listactivities) - Get all activities
* [cancelActivity](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity * [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) ### [butler](docs/sdks/butler/README.md)
* [stopTasks](docs/sdks/butler/README.md#stoptasks) - Stop all Butler tasks * [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 * [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 * [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) ### [preferences](docs/sdks/preferences/README.md)
* [getAllPreferences](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences * [getAllPreferences](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
@@ -424,51 +477,65 @@ run();
* [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates * [checkUpdates](docs/sdks/updater/README.md#checkupdates) - Checking for updates
* [getUpdatesStatus](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of 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> </details>
<!-- End Available Resources and Operations [operations] --> <!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] --> <!-- Start Error Handling [errors] -->
## Error Handling ## Error Handling
[`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties: [`PlexAPIError`](./src/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description | | Property | Type | Description |
| ------------------- | ---------- | ------------------------------------------------------ | | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| `error.message` | `string` | Error message | | `error.message` | `string` | Error message |
| `error.statusCode` | `number` | HTTP response status code eg `404` | | `error.statusCode` | `number` | HTTP response status code eg `404` |
| `error.headers` | `Headers` | HTTP response headers | | `error.headers` | `Headers` | HTTP response headers |
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. | | `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
| `error.rawResponse` | `Response` | Raw HTTP response | | `error.rawResponse` | `Response` | Raw HTTP response |
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
### Example ### Example
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/sdk/models/errors"; import * as errors from "@lukehagar/plexjs/models/errors";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
try { try {
const result = await plexAPI.general.getServerInfo({}); const result = await plexAPI.authentication.getTokenDetails({});
console.log(result); console.log(result);
} catch (error) { } catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.PlexAPIError) { if (error instanceof errors.PlexAPIError) {
console.log(error.message); console.log(error.message);
console.log(error.statusCode); console.log(error.statusCode);
console.log(error.body); console.log(error.body);
console.log(error.headers); console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.GetTokenDetailsBadRequestError) {
console.log(error.data$.errors); // GetTokenDetailsBadRequestError[]
}
} }
} }
} }
@@ -479,24 +546,33 @@ run();
### Error Classes ### Error Classes
**Primary error:** **Primary error:**
* [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts): The base class for HTTP error responses. * [`PlexAPIError`](./src/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 /> <br />
**Network errors:** **Network errors:**
* [`ConnectionError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
**Inherit from [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts)**: **Inherit from [`PlexAPIError`](./src/models/errors/plexapierror.ts)**:
* [`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. * [`GetTokenDetailsBadRequestError`](./src/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/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/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/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/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/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/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/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> </details>
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] --> <!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] --> <!-- Start Server Selection [server] -->
@@ -510,39 +586,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` | | | 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<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: 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 | | Variable | Parameter | Default | Description |
| ---------------- | ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `identifier` | `identifier: string` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS | | `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 | | `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/> | | `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`) | | `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/> | | `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 | | `full_server_url` | `fullServerUrl: string` | `"http://localhost:32400"` | The full manual URL to access the PMS |
#### Example #### Example
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
serverIdx: 1, serverIdx: 0,
protocol: "<value>", identifier: "0123456789abcdef0123456789abcdef",
host: "electric-excess.name", ipDescription: "1-2-3-4",
port: "36393", port: "32400",
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
@@ -560,19 +639,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: 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 ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
serverURL: "https://http://localhost:32400", serverURL: "https://http://localhost:32400",
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
@@ -583,6 +665,40 @@ async function run() {
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/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] --> <!-- End Server Selection [server] -->
@@ -643,25 +759,27 @@ const sdk = new PlexAPI({ httpClient: httpClient });
This SDK supports the following security scheme globally: This SDK supports the following security scheme globally:
| Name | Type | Scheme | | Name | Type | Scheme |
| -------- | ------ | ------- | | ------- | ------ | ------- |
| `apiKey` | apiKey | API key | | `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 ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
apiKey: "<YOUR_API_KEY_HERE>", token: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
}); });
async function run() { async function run() {
@@ -698,6 +816,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`activitiesCancelActivity`](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity - [`activitiesCancelActivity`](docs/sdks/activities/README.md#cancelactivity) - Cancel a running activity
- [`activitiesListActivities`](docs/sdks/activities/README.md#listactivities) - Get all activities - [`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 - [`butlerGetTasks`](docs/sdks/butler/README.md#gettasks) - Get all Butler tasks
- [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task - [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
- [`butlerStartTasks`](docs/sdks/butler/README.md#starttasks) - Start all Butler tasks - [`butlerStartTasks`](docs/sdks/butler/README.md#starttasks) - Start all Butler tasks
@@ -894,6 +1014,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`playQueueResetPlayQueue`](docs/sdks/playqueue/README.md#resetplayqueue) - Reset a play queue - [`playQueueResetPlayQueue`](docs/sdks/playqueue/README.md#resetplayqueue) - Reset a play queue
- [`playQueueShuffle`](docs/sdks/playqueue/README.md#shuffle) - Shuffle 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 - [`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 - [`preferencesGetAllPreferences`](docs/sdks/preferences/README.md#getallpreferences) - Get all preferences
- [`preferencesGetPreference`](docs/sdks/preferences/README.md#getpreference) - Get a preferences - [`preferencesGetPreference`](docs/sdks/preferences/README.md#getpreference) - Get a preferences
- [`preferencesSetPreferences`](docs/sdks/preferences/README.md#setpreferences) - Set preferences - [`preferencesSetPreferences`](docs/sdks/preferences/README.md#setpreferences) - Set preferences
@@ -933,6 +1054,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Applying updates - [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Applying updates
- [`updaterCheckUpdates`](docs/sdks/updater/README.md#checkupdates) - Checking for updates - [`updaterCheckUpdates`](docs/sdks/updater/README.md#checkupdates) - Checking for updates
- [`updaterGetUpdatesStatus`](docs/sdks/updater/README.md#getupdatesstatus) - Querying status of 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> </details>
<!-- End Standalone functions [standalone-funcs] --> <!-- End Standalone functions [standalone-funcs] -->
@@ -955,12 +1077,12 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { openAsBlob } from "node:fs"; import { openAsBlob } from "node:fs";
const plexAPI = new PlexAPI(); const plexAPI = new PlexAPI({
token: "<YOUR_API_KEY_HERE>",
});
async function run() { async function run() {
const result = await plexAPI.log.writeLog(await openAsBlob("example.file")); await plexAPI.log.writeLog(await openAsBlob("example.file"));
console.log(result);
} }
run(); run();
@@ -976,18 +1098,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: To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {
@@ -1014,6 +1139,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: 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 ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
retryConfig: { retryConfig: {
@@ -1026,16 +1152,18 @@ const plexAPI = new PlexAPI({
}, },
retryConnectionErrors: false, retryConnectionErrors: false,
}, },
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { async function run() {

View File

@@ -1409,3 +1409,53 @@ Based on:
- [typescript v0.41.0] . - [typescript v0.41.0] .
### Releases ### 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 - .
## 2025-12-01 01:48:15
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.665.0 (2.767.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.44.1] .
### Releases
- [NPM v0.44.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.44.1 - .

View File

@@ -1,22 +1,66 @@
<!-- Start SDK Example Usage [usage] --> <!-- Start SDK Example Usage [usage] -->
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123", accepts: Accepts.ApplicationXml,
xPlexProduct: "Plex for Roku", clientIdentifier: "abc123",
xPlexVersion: "2.4.1", product: "Plex for Roku",
xPlexPlatform: "Roku", version: "2.4.1",
xPlexPlatformVersion: "4.3 build 1057", platform: "Roku",
xPlexDevice: "Roku 3", platformVersion: "4.3 build 1057",
xPlexModel: "4200X", device: "Roku 3",
xPlexDeviceVendor: "Roku", model: "4200X",
xPlexDeviceName: "Living Room TV", deviceVendor: "Roku",
xPlexMarketplace: "googlePlay", deviceName: "Living Room TV",
marketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
}); });
async function run() { 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); console.log(result);
} }

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,17 @@
# GetServerResourcesUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetServerResourcesUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetServerResourcesError](../../models/operations/getserverresourceserror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# GetTokenDetailsBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetTokenDetailsBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetTokenDetailsBadRequestError](../../models/operations/gettokendetailsbadrequesterror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# GetTokenDetailsUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetTokenDetailsUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetTokenDetailsUnauthorizedError](../../models/operations/gettokendetailsunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# GetUsersBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetUsersBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `errors` | [operations.GetUsersBadRequestError](../../models/operations/getusersbadrequesterror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# GetUsersUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetUsersUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `errors` | [operations.GetUsersUnauthorizedError](../../models/operations/getusersunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# PostUsersSignInDataBadRequestError
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { PostUsersSignInDataBadRequestError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataBadRequestError](../../models/operations/postuserssignindatabadrequesterror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# PostUsersSignInDataUnauthorizedError
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { PostUsersSignInDataUnauthorizedError } from "@lukehagar/plexjs/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `errors` | [operations.PostUsersSignInDataUnauthorizedError](../../models/operations/postuserssignindataunauthorizederror.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { Account } from "@lukehagar/plexjs/sdk/models/operations"; import { Account } from "@lukehagar/plexjs/models/operations";
let value: Account = {}; let value: Account = {};
``` ```

View File

@@ -5,7 +5,7 @@ The action to perform for this item on this optimizer queue
## Example Usage ## Example Usage
```typescript ```typescript
import { Action } from "@lukehagar/plexjs/sdk/models/operations"; import { Action } from "@lukehagar/plexjs/models/operations";
let value: Action = Action.Enable; let value: Action = Action.Enable;
``` ```

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { Activity } from "@lukehagar/plexjs/sdk/models/operations"; import { Activity } from "@lukehagar/plexjs/models/operations";
let value: Activity = {}; let value: Activity = {};
``` ```

View File

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

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

View File

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

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

View File

@@ -0,0 +1,19 @@
# AddDeviceToDVRDVR
## Example Usage
```typescript
import { AddDeviceToDVRDVR } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRDVR = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `device` | [shared.Device](../../models/shared/device.md)[] | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `language` | *string* | :heavy_minus_sign: | N/A |
| `lineup` | *string* | :heavy_minus_sign: | N/A |
| `uuid` | *string* | :heavy_minus_sign: | N/A |

View File

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

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddDeviceToDVRMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { AddDeviceToDVRMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRMediaContainer = {}; let value: AddDeviceToDVRMediaContainer = {};
``` ```
@@ -11,6 +11,6 @@ let value: AddDeviceToDVRMediaContainer = {};
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainerMediaContainer](../../../sdk/models/operations/adddevicetodvrmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A | | `mediaContainer` | [operations.AddDeviceToDVRMediaContainerMediaContainer](../../models/operations/adddevicetodvrmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | [operations.AddDeviceToDVRDVR](../../../sdk/models/operations/adddevicetodvrdvr.md)[] | :heavy_minus_sign: | N/A | | `dvr` | [operations.AddDeviceToDVRDVR](../../models/operations/adddevicetodvrdvr.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage ## Example Usage
```typescript ```typescript
import { AddDeviceToDVRMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { AddDeviceToDVRMediaContainerMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRMediaContainerMediaContainer = {}; let value: AddDeviceToDVRMediaContainerMediaContainer = {};
``` ```

View File

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

View File

@@ -0,0 +1,27 @@
# AddDeviceToDVRResponse
## Example Usage
```typescript
import { AddDeviceToDVRResponse } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
"<value 2>",
],
},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.AddDeviceToDVRResponseBody](../../models/operations/adddevicetodvrresponsebody.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,17 @@
# AddDeviceToDVRResponseBody
OK
## Example Usage
```typescript
import { AddDeviceToDVRResponseBody } from "@lukehagar/plexjs/models/operations";
let value: AddDeviceToDVRResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddDeviceToDVRMediaContainer](../../models/operations/adddevicetodvrmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -3,19 +3,19 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/sdk/models/operations"; import { AddDownloadQueueItemsGlobals } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsGlobals = { let value: AddDownloadQueueItemsGlobals = {
xPlexClientIdentifier: "abc123", clientIdentifier: "abc123",
xPlexProduct: "Plex for Roku", product: "Plex for Roku",
xPlexVersion: "2.4.1", version: "2.4.1",
xPlexPlatform: "Roku", platform: "Roku",
xPlexPlatformVersion: "4.3 build 1057", platformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3", device: "Roku 3",
xPlexModel: "4200X", model: "4200X",
xPlexDeviceVendor: "Roku", deviceVendor: "Roku",
xPlexDeviceName: "Living Room TV", deviceName: "Living Room TV",
xPlexMarketplace: "googlePlay", marketplace: "googlePlay",
}; };
``` ```
@@ -23,13 +23,14 @@ let value: AddDownloadQueueItemsGlobals = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage ## Example Usage
```typescript ```typescript
import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsMediaContainer = {}; let value: AddDownloadQueueItemsMediaContainer = {};
``` ```
@@ -21,4 +21,4 @@ let value: AddDownloadQueueItemsMediaContainer = {};
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> | | `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *number* | :heavy_minus_sign: | N/A | | `size` | *number* | :heavy_minus_sign: | N/A |
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> | | `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `addedQueueItems` | [operations.AddedQueueItem](../../../sdk/models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A | | `addedQueueItems` | [operations.AddedQueueItem](../../models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -3,8 +3,8 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { AddDownloadQueueItemsRequest } from "@lukehagar/plexjs/models/operations";
import { AdvancedSubtitles, BoolInt, LocationParameter, Protocol, Subtitles } from "@lukehagar/plexjs/sdk/models/shared"; import { AdvancedSubtitles, BoolInt, LocationParameter, ProtocolParameter, Subtitles } from "@lukehagar/plexjs/models/shared";
let value: AddDownloadQueueItemsRequest = { let value: AddDownloadQueueItemsRequest = {
queueId: 44894, queueId: 44894,
@@ -15,13 +15,13 @@ let value: AddDownloadQueueItemsRequest = {
advancedSubtitles: AdvancedSubtitles.Burn, advancedSubtitles: AdvancedSubtitles.Burn,
audioBoost: 50, audioBoost: 50,
audioChannelCount: 5, audioChannelCount: 5,
autoAdjustQuality: BoolInt.One, autoAdjustQuality: BoolInt.True,
autoAdjustSubtitle: BoolInt.One, autoAdjustSubtitle: BoolInt.True,
directPlay: BoolInt.One, directPlay: BoolInt.True,
directStream: BoolInt.One, directStream: BoolInt.True,
directStreamAudio: BoolInt.One, directStreamAudio: BoolInt.True,
disableResolutionRotation: BoolInt.One, disableResolutionRotation: BoolInt.True,
hasMDE: BoolInt.One, hasMDE: BoolInt.True,
location: LocationParameter.Wan, location: LocationParameter.Wan,
mediaBufferSize: 102400, mediaBufferSize: 102400,
mediaIndex: 0, mediaIndex: 0,
@@ -31,7 +31,7 @@ let value: AddDownloadQueueItemsRequest = {
path: "/library/metadata/151671", path: "/library/metadata/151671",
peakBitrate: 12000, peakBitrate: 12000,
photoResolution: "1080x1080", photoResolution: "1080x1080",
protocol: Protocol.Dash, protocol: ProtocolParameter.Dash,
secondsPerSegment: 5, secondsPerSegment: 5,
subtitleSize: 50, subtitleSize: 50,
subtitles: Subtitles.Sidecar, subtitles: Subtitles.Sidecar,
@@ -45,29 +45,30 @@ let value: AddDownloadQueueItemsRequest = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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 | | | `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/>] | | `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 | | `advancedSubtitles` | [shared.AdvancedSubtitles](../../models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
| `audioBoost` | *number* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 | | `audioBoost` | *number* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
| `audioChannelCount` | *number* | :heavy_minus_sign: | Target video number of audio channels. | 5 | | `audioChannelCount` | *number* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
| `autoAdjustQuality` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 | | `autoAdjustQuality` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
| `autoAdjustSubtitle` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 | | `autoAdjustSubtitle` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
| `directPlay` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 | | `directPlay` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
| `directStream` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 | | `directStream` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
| `directStreamAudio` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 | | `directStreamAudio` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
| `disableResolutionRotation` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 | | `disableResolutionRotation` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
| `hasMDE` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 | | `hasMDE` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
| `location` | [shared.LocationParameter](../../../sdk/models/shared/locationparameter.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan | | `location` | [shared.LocationParameter](../../models/shared/locationparameter.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
| `mediaBufferSize` | *number* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 | | `mediaBufferSize` | *number* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
| `mediaIndex` | *number* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 | | `mediaIndex` | *number* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
| `musicBitrate` | *number* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 | | `musicBitrate` | *number* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
@@ -76,10 +77,10 @@ let value: AddDownloadQueueItemsRequest = {
| `path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 | | `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 | | `peakBitrate` | *number* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
| `photoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 | | `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](../../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 | | `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 | | `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 | | `subtitles` | [shared.Subtitles](../../models/shared/subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
| `videoBitrate` | *number* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 | | `videoBitrate` | *number* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
| `videoQuality` | *number* | :heavy_minus_sign: | Target photo quality. | 50 | | `videoQuality` | *number* | :heavy_minus_sign: | Target photo quality. | 50 |
| `videoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 | | `videoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |

View File

@@ -0,0 +1,17 @@
# AddDownloadQueueItemsResponse
OK
## Example Usage
```typescript
import { AddDownloadQueueItemsResponse } from "@lukehagar/plexjs/models/operations";
let value: AddDownloadQueueItemsResponse = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddDownloadQueueItemsMediaContainer](../../models/operations/adddownloadqueueitemsmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddedQueueItem } from "@lukehagar/plexjs/sdk/models/operations"; import { AddedQueueItem } from "@lukehagar/plexjs/models/operations";
let value: AddedQueueItem = {}; let value: AddedQueueItem = {};
``` ```

View File

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

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

View File

@@ -0,0 +1,19 @@
# AddLineupDVR
## Example Usage
```typescript
import { AddLineupDVR } from "@lukehagar/plexjs/models/operations";
let value: AddLineupDVR = {};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `device` | [shared.Device](../../models/shared/device.md)[] | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `language` | *string* | :heavy_minus_sign: | N/A |
| `lineup` | *string* | :heavy_minus_sign: | N/A |
| `uuid` | *string* | :heavy_minus_sign: | N/A |

View File

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

@@ -0,0 +1,16 @@
# AddLineupMediaContainer
## Example Usage
```typescript
import { AddLineupMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddLineupMediaContainer = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddLineupMediaContainerMediaContainer](../../models/operations/addlineupmediacontainermediacontainer.md) | :heavy_minus_sign: | N/A |
| `dvr` | [operations.AddLineupDVR](../../models/operations/addlineupdvr.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -8,7 +8,7 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage ## Example Usage
```typescript ```typescript
import { AddLineupMediaContainerMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { AddLineupMediaContainerMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: AddLineupMediaContainerMediaContainer = {}; let value: AddLineupMediaContainerMediaContainer = {};
``` ```

View File

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

View File

@@ -0,0 +1,27 @@
# AddLineupResponse
## Example Usage
```typescript
import { AddLineupResponse } from "@lukehagar/plexjs/models/operations";
let value: AddLineupResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
"<value 2>",
],
},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.AddLineupResponseBody](../../models/operations/addlineupresponsebody.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,17 @@
# AddLineupResponseBody
OK
## Example Usage
```typescript
import { AddLineupResponseBody } from "@lukehagar/plexjs/models/operations";
let value: AddLineupResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.AddLineupMediaContainer](../../models/operations/addlineupmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

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

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

View File

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

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

View File

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

@@ -5,7 +5,7 @@ The preferences for this section
## Example Usage ## Example Usage
```typescript ```typescript
import { AddSectionPrefs } from "@lukehagar/plexjs/sdk/models/operations"; import { AddSectionPrefs } from "@lukehagar/plexjs/models/operations";
let value: AddSectionPrefs = {}; let value: AddSectionPrefs = {};
``` ```

View File

@@ -0,0 +1,48 @@
# AddSectionRequest
## Example Usage
```typescript
import { AddSectionRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddSectionRequest = {
name: "<value>",
type: 583726,
agent: "<value>",
language: "<value>",
locations: [
"O:\fatboy\\Media\\Ripped\\Music",
"O:\fatboy\\Media\\My Music",
],
prefs: {},
relative: BoolInt.True,
importFromiTunes: BoolInt.True,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `accepts` | [shared.Accepts](../../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 | |
| `agent` | *string* | :heavy_check_mark: | The agent this section should use for metadata | |
| `metadataAgentProviderGroupId` | *string* | :heavy_minus_sign: | The agent group id for this section | |
| `language` | *string* | :heavy_check_mark: | The language of this section | |
| `locations` | *string*[] | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
| `prefs` | [operations.AddSectionPrefs](../../models/operations/addsectionprefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
| `relative` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
| `importFromiTunes` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |

View File

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

@@ -3,13 +3,13 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddSubtitlesRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { AddSubtitlesRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared"; import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddSubtitlesRequest = { let value: AddSubtitlesRequest = {
ids: "<value>", ids: "<value>",
forced: BoolInt.One, forced: BoolInt.True,
hearingImpaired: BoolInt.One, hearingImpaired: BoolInt.True,
}; };
``` ```
@@ -17,21 +17,22 @@ let value: AddSubtitlesRequest = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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 | | | `ids` | *string* | :heavy_check_mark: | N/A | |
| `title` | *string* | :heavy_minus_sign: | N/A | | | `title` | *string* | :heavy_minus_sign: | N/A | |
| `language` | *string* | :heavy_minus_sign: | N/A | | | `language` | *string* | :heavy_minus_sign: | N/A | |
| `mediaItemID` | *number* | :heavy_minus_sign: | N/A | | | `mediaItemID` | *number* | :heavy_minus_sign: | N/A | |
| `url` | *string* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | | | `url` | *string* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
| `format` | *string* | :heavy_minus_sign: | N/A | | | `format` | *string* | :heavy_minus_sign: | N/A | |
| `forced` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 | | `forced` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |
| `hearingImpaired` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 | | `hearingImpaired` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | N/A | 1 |

View File

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

@@ -3,12 +3,12 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { AddToPlayQueueRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { AddToPlayQueueRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared"; import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: AddToPlayQueueRequest = { let value: AddToPlayQueueRequest = {
playQueueId: 354193, playQueueId: 354193,
next: BoolInt.One, next: BoolInt.True,
}; };
``` ```
@@ -16,17 +16,18 @@ let value: AddToPlayQueueRequest = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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. | | | `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. | | | `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. | | | `playlistID` | *string* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
| `next` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 | | `next` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |

View File

@@ -0,0 +1,23 @@
# AdvancedSubtitles
## Example Usage
```typescript
import { AdvancedSubtitles } from "@lukehagar/plexjs/models/operations";
let value: AdvancedSubtitles = AdvancedSubtitles.Auto;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Auto` | auto |
| `Burn` | burn |
| `None` | none |
| `Sidecar` | sidecar |
| `Embedded` | embedded |
| `Segmented` | segmented |
| - | `Unrecognized<string>` |

View File

@@ -0,0 +1,21 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Example Usage
```typescript
import { AllLibraries } from "@lukehagar/plexjs/models/operations";
let value: AllLibraries = AllLibraries.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

@@ -0,0 +1,21 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Example Usage
```typescript
import { AllowCameraUpload } from "@lukehagar/plexjs/models/operations";
let value: AllowCameraUpload = AllowCameraUpload.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

@@ -0,0 +1,21 @@
# AllowChannels
Indicates if the user has access to channels.
## Example Usage
```typescript
import { AllowChannels } from "@lukehagar/plexjs/models/operations";
let value: AllowChannels = AllowChannels.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

@@ -0,0 +1,21 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Example Usage
```typescript
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/models/operations";
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

@@ -0,0 +1,21 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Example Usage
```typescript
import { AllowSync } from "@lukehagar/plexjs/models/operations";
let value: AllowSync = AllowSync.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

@@ -0,0 +1,21 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Example Usage
```typescript
import { AllowTuners } from "@lukehagar/plexjs/models/operations";
let value: AllowTuners = AllowTuners.Enable;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Disable` | 0 |
| `Enable` | 1 |
| - | `Unrecognized<number>` |

View File

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

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

View File

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

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

View File

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

@@ -0,0 +1,37 @@
# AutocompleteRequest
## Example Usage
```typescript
import { AutocompleteRequest } from "@lukehagar/plexjs/models/operations";
import { MediaType } from "@lukehagar/plexjs/models/shared";
let value: AutocompleteRequest = {
sectionId: 594987,
mediaQuery: {
type: MediaType.Episode,
sourceType: 2,
sort: "duration:desc,index",
},
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../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](../../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,227 @@
# AutocompleteResponse
## Example Usage
```typescript
import { AutocompleteResponse } from "@lukehagar/plexjs/models/operations";
let value: AutocompleteResponse = {
headers: {
"key": [
"<value 1>",
],
"key1": [
"<value 1>",
],
"key2": [
"<value 1>",
"<value 2>",
],
},
result: {
mediaContainer: {
metadata: [
{
title: "<value>",
type: "<value>",
addedAt: 29550,
art: "/library/metadata/58683/art/1703239236",
autotag: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"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",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
director: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
genre: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
guid: "plex://movie/5d7768ba96b655001fdc0408",
guids: [
{
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,
audioChannels: 2,
audioCodec: "aac",
audioProfile: "lc",
bitrate: 5612,
container: "mov",
duration: 150192,
has64bitOffsets: false,
hasVoiceActivity: true,
height: 544,
id: 1,
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: "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",
codedHeight: 1608,
codedWidth: 3840,
closedCaptions: true,
codec: "hevc",
colorPrimaries: "bt2020",
colorRange: "tv",
colorSpace: "bt2020nc",
colorTrc: "smpte2084",
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
frameRate: 23.976,
hasScalingMatrix: false,
height: 1602,
id: 1002625,
index: 0,
key: "/library/streams/216389",
language: "English",
languageCode: "eng",
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,
width: 3840,
},
],
videoProfile: "main",
},
],
videoCodec: "h264",
videoFrameRate: "24p",
videoProfile: "main",
videoResolution: "720",
width: 1280,
},
],
originallyAvailableAt: new Date("2022-12-14"),
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
ratingArray: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
role: [
{
filter: "actor=49",
ratingKey: "58683",
role: "Secretary",
tag: "Shaun Lawton",
tagKey: "5d3ee12c4cde6a001c3e0b27",
thumb:
"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",
thumb:
"http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
},
],
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [shared.MediaContainerWithMetadata](../../models/shared/mediacontainerwithmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { Bandwidth } from "@lukehagar/plexjs/sdk/models/operations"; import { Bandwidth } from "@lukehagar/plexjs/models/operations";
let value: Bandwidth = {}; let value: Bandwidth = {};
``` ```

View File

@@ -0,0 +1,17 @@
# Bandwidths
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
## Example Usage
```typescript
import { Bandwidths } from "@lukehagar/plexjs/models/operations";
let value: Bandwidths = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `bandwidth` | [operations.Bandwidth](../../models/operations/bandwidth.md)[] | :heavy_minus_sign: | N/A |

View File

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

View File

@@ -0,0 +1,15 @@
# ButlerTasks
## Example Usage
```typescript
import { ButlerTasks } from "@lukehagar/plexjs/models/operations";
let value: ButlerTasks = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `butlerTask` | [operations.GetTasksButlerTask](../../models/operations/gettasksbutlertask.md)[] | :heavy_minus_sign: | N/A |

View File

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

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

View File

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

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

View File

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

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

View File

@@ -5,7 +5,7 @@ The mapping of changes, passed as a map of device channel to lineup key.
## Example Usage ## Example Usage
```typescript ```typescript
import { ChannelMappingByKey } from "@lukehagar/plexjs/sdk/models/operations"; import { ChannelMappingByKey } from "@lukehagar/plexjs/models/operations";
let value: ChannelMappingByKey = {}; let value: ChannelMappingByKey = {};
``` ```

View File

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

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

View File

@@ -10,7 +10,7 @@ Defaults to 3 (444)
## Example Usage ## Example Usage
```typescript ```typescript
import { ChromaSubsampling } from "@lukehagar/plexjs/sdk/models/operations"; import { ChromaSubsampling } from "@lukehagar/plexjs/models/operations";
let value: ChromaSubsampling = ChromaSubsampling.Two; let value: ChromaSubsampling = ChromaSubsampling.Two;
``` ```

View File

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

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

View File

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

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

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { ComputeChannelMapChannelMapping } from "@lukehagar/plexjs/sdk/models/operations"; import { ComputeChannelMapChannelMapping } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapChannelMapping = {}; let value: ComputeChannelMapChannelMapping = {};
``` ```

View File

@@ -3,19 +3,19 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { ComputeChannelMapGlobals } from "@lukehagar/plexjs/sdk/models/operations"; import { ComputeChannelMapGlobals } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapGlobals = { let value: ComputeChannelMapGlobals = {
xPlexClientIdentifier: "abc123", clientIdentifier: "abc123",
xPlexProduct: "Plex for Roku", product: "Plex for Roku",
xPlexVersion: "2.4.1", version: "2.4.1",
xPlexPlatform: "Roku", platform: "Roku",
xPlexPlatformVersion: "4.3 build 1057", platformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3", device: "Roku 3",
xPlexModel: "4200X", model: "4200X",
xPlexDeviceVendor: "Roku", deviceVendor: "Roku",
xPlexDeviceName: "Living Room TV", deviceName: "Living Room TV",
xPlexMarketplace: "googlePlay", marketplace: "googlePlay",
}; };
``` ```
@@ -23,13 +23,14 @@ let value: ComputeChannelMapGlobals = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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 @@ The container often "hoists" common attributes from its children. For example, i
## Example Usage ## Example Usage
```typescript ```typescript
import { ComputeChannelMapMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { ComputeChannelMapMediaContainer } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapMediaContainer = {}; let value: ComputeChannelMapMediaContainer = {};
``` ```
@@ -21,4 +21,4 @@ let value: ComputeChannelMapMediaContainer = {};
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> | | `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `size` | *number* | :heavy_minus_sign: | N/A | | `size` | *number* | :heavy_minus_sign: | N/A |
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> | | `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `channelMapping` | [operations.ComputeChannelMapChannelMapping](../../../sdk/models/operations/computechannelmapchannelmapping.md)[] | :heavy_minus_sign: | N/A | | `channelMapping` | [operations.ComputeChannelMapChannelMapping](../../models/operations/computechannelmapchannelmapping.md)[] | :heavy_minus_sign: | N/A |

View File

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

View File

@@ -0,0 +1,19 @@
# ComputeChannelMapResponse
## Example Usage
```typescript
import { ComputeChannelMapResponse } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapResponse = {
headers: {},
result: {},
};
```
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `headers` | Record<string, *string*[]> | :heavy_check_mark: | N/A |
| `result` | [operations.ComputeChannelMapResponseBody](../../models/operations/computechannelmapresponsebody.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,17 @@
# ComputeChannelMapResponseBody
OK
## Example Usage
```typescript
import { ComputeChannelMapResponseBody } from "@lukehagar/plexjs/models/operations";
let value: ComputeChannelMapResponseBody = {};
```
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.ComputeChannelMapMediaContainer](../../models/operations/computechannelmapmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { Connection } from "@lukehagar/plexjs/sdk/models/operations"; import { Connection } from "@lukehagar/plexjs/models/operations";
let value: Connection = {}; let value: Connection = {};
``` ```

View File

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

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

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

@@ -0,0 +1,34 @@
# CreateCollectionRequest
## Example Usage
```typescript
import { CreateCollectionRequest } from "@lukehagar/plexjs/models/operations";
import { MediaType } from "@lukehagar/plexjs/models/shared";
let value: CreateCollectionRequest = {
sectionId: "<id>",
type: MediaType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts` | [shared.Accepts](../../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](../../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

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

@@ -3,15 +3,15 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { CreateCustomHubRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { CreateCustomHubRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared"; import { BoolInt } from "@lukehagar/plexjs/models/shared";
let value: CreateCustomHubRequest = { let value: CreateCustomHubRequest = {
sectionId: 94028, sectionId: 94028,
metadataItemId: 822624, metadataItemId: 822624,
promotedToRecommended: BoolInt.One, promotedToRecommended: BoolInt.True,
promotedToOwnHome: BoolInt.One, promotedToOwnHome: BoolInt.True,
promotedToSharedHome: BoolInt.One, promotedToSharedHome: BoolInt.True,
}; };
``` ```
@@ -19,18 +19,19 @@ let value: CreateCustomHubRequest = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 | | `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku | | `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 | | `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku | | `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku | | `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV | | `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay | | `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 | | | `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 | | | `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 | | `promotedToRecommended` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
| `promotedToOwnHome` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 | | `promotedToOwnHome` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
| `promotedToSharedHome` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 | | `promotedToSharedHome` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |

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