Compare commits

...

1 Commits

Author SHA1 Message Date
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
923 changed files with 48209 additions and 41897 deletions

File diff suppressed because one or more lines are too long

View File

@@ -22,7 +22,7 @@ generation:
generateNewTests: true
skipResponseBodyAssertions: false
typescript:
version: 0.41.0
version: 0.42.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}

File diff suppressed because it is too large Load Diff

View File

@@ -9,20 +9,20 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257
sourceRevisionDigest: sha256:bc60551015634fd59475cf17983ca3aedcab591426d526ab1e3634b1feedaec1
sourceBlobDigest: sha256:fc8cd5343a94564b646830738f38e065d61e2ea63e4a1383ce07533586889950
tags:
- latest
- speakeasy-sdk-regen-1760246702
- speakeasy-sdk-regen-1760248310
- 1.1.1
targets:
plexjs:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:d10668c0bc8779046995836bd0e5b4e681f3a1661df05ef984d3951b16891135
sourceBlobDigest: sha256:0e84e36799922513fa9fde276e7ed24d7e8ceef23d40f347d4aa7a40fddc2257
sourceRevisionDigest: sha256:bc60551015634fd59475cf17983ca3aedcab591426d526ab1e3634b1feedaec1
sourceBlobDigest: sha256:fc8cd5343a94564b646830738f38e065d61e2ea63e4a1383ce07533586889950
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:49b6f9d7cbbdae2b95c455771f7a7e9544fa64695d7326650a4a93a255ba101b
codeSamplesRevisionDigest: sha256:341820816861b13701967c2a958e9654d258aeb27b83f2e875cb14ee316fa85c
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

View File

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

207
README.md
View File

@@ -72,22 +72,65 @@ yarn add @lukehagar/plexjs
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
Extension,
StartTranscodeSessionLocation,
StartTranscodeSessionProtocol,
} from "@lukehagar/plexjs/sdk/models/operations";
import {
Accepts,
AdvancedSubtitles,
BoolInt,
TranscodeType,
} from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
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.One,
autoAdjustSubtitle: BoolInt.One,
directPlay: BoolInt.One,
directStream: BoolInt.One,
directStreamAudio: BoolInt.One,
disableResolutionRotation: BoolInt.One,
hasMDE: BoolInt.One,
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);
}
@@ -444,18 +487,20 @@ run();
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/sdk/models/errors";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -527,22 +572,24 @@ If the selected server has variables, you may override its default values throug
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
serverIdx: 1,
protocol: "<value>",
host: "electric-excess.name",
port: "36393",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -560,19 +607,21 @@ run();
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
serverURL: "https://http://localhost:32400",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -642,26 +691,28 @@ const sdk = new PlexAPI({ httpClient: httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| -------- | ------ | ------- |
| `apiKey` | apiKey | API key |
| Name | Type | Scheme |
| ------- | ------ | ------- |
| `token` | apiKey | API key |
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
apiKey: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
token: "<YOUR_API_KEY_HERE>",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -976,18 +1027,20 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {
@@ -1014,6 +1067,7 @@ run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
const plexAPI = new PlexAPI({
retryConfig: {
@@ -1026,16 +1080,17 @@ const plexAPI = new PlexAPI({
},
retryConnectionErrors: false,
},
xPlexClientIdentifier: "abc123",
xPlexProduct: "Plex for Roku",
xPlexVersion: "2.4.1",
xPlexPlatform: "Roku",
xPlexPlatformVersion: "4.3 build 1057",
xPlexDevice: "Roku 3",
xPlexModel: "4200X",
xPlexDeviceVendor: "Roku",
xPlexDeviceName: "Living Room TV",
xPlexMarketplace: "googlePlay",
accepts: Accepts.ApplicationXml,
clientIdentifier: "abc123",
product: "Plex for Roku",
version: "2.4.1",
platform: "Roku",
platformVersion: "4.3 build 1057",
device: "Roku 3",
model: "4200X",
deviceVendor: "Roku",
deviceName: "Living Room TV",
marketplace: "googlePlay",
});
async function run() {

View File

@@ -1408,4 +1408,14 @@ Based on:
### Generated
- [typescript v0.41.0] .
### Releases
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
- [NPM v0.41.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.41.0 - .
## 2025-10-12 05:51:28
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.42.0] .
### Releases
- [NPM v0.42.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.42.0 - .

View File

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

File diff suppressed because it is too large Load Diff

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -45,16 +45,17 @@ let value: AddDownloadQueueItemsRequest = {
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `queueId` | *number* | :heavy_check_mark: | The queue id | |
| `keys` | *string*[] | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
| `advancedSubtitles` | [shared.AdvancedSubtitles](../../../sdk/models/shared/advancedsubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -17,16 +17,17 @@ let value: DeleteMediaItemRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `mediaItem` | *string* | :heavy_check_mark: | N/A | |
| `proxy` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether proxy items, such as media optimized versions, should also be deleted. Defaults to false. | 1 |

View File

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

View File

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

View File

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

View File

@@ -16,15 +16,16 @@ let value: DeleteMetadataItemRequest = {
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `xPlexProduct` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `xPlexVersion` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `xPlexPlatform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `xPlexPlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexDevice` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `xPlexModel` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexDeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `xPlexDeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `xPlexMarketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `accepts` | [shared.Accepts](../../../sdk/models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ids` | *string* | :heavy_check_mark: | N/A | |
| `proxy` | [shared.BoolInt](../../../sdk/models/shared/boolint.md) | :heavy_minus_sign: | Whether proxy items, such as media optimized versions, should also be deleted. Defaults to false. | 1 |

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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