overlay: 1.0.0 info: title: CodeSamples overlay for typescript target version: 0.0.0 actions: - target: $["paths"]["/"]["get"] update: x-codeSamples: - lang: typescript label: getServerCapabilities source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); - target: $["paths"]["/:/prefs"]["get"] update: x-codeSamples: - lang: typescript label: getServerPreferences source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getServerPreferences(); // Handle the result console.log(result); } run(); - target: $["paths"]["/:/progress"]["post"] update: x-codeSamples: - lang: typescript label: updatePlayProgress source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.media.updatePlayProgress("", 90000, "played"); // Handle the result console.log(result); } run(); - target: $["paths"]["/:/scrobble"]["get"] update: x-codeSamples: - lang: typescript label: markPlayed source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.media.markPlayed(59398); // Handle the result console.log(result); } run(); - target: $["paths"]["/:/timeline"]["get"] update: x-codeSamples: - lang: typescript label: getTimeline source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { State } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.video.getTimeline({ ratingKey: 23409, key: "/library/metadata/23409", state: State.Playing, hasMDE: 1, time: 2000, duration: 10000, context: "home:hub.continueWatching", playQueueItemID: 1, playBackTime: 2000, row: 1, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/:/unscrobble"]["get"] update: x-codeSamples: - lang: typescript label: markUnplayed source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.media.markUnplayed(59398); // Handle the result console.log(result); } run(); - target: $["paths"]["/activities"]["get"] update: x-codeSamples: - lang: typescript label: getServerActivities source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.activities.getServerActivities(); // Handle the result console.log(result); } run(); - target: $["paths"]["/activities/{activityUUID}"]["delete"] update: x-codeSamples: - lang: typescript label: cancelServerActivities source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.activities.cancelServerActivities("25b71ed5-0f9d-461c-baa7-d404e9e10d3e"); // Handle the result console.log(result); } run(); - target: $["paths"]["/butler"]["delete"] update: x-codeSamples: - lang: typescript label: stopAllTasks source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.butler.stopAllTasks(); // Handle the result console.log(result); } run(); - target: $["paths"]["/butler"]["get"] update: x-codeSamples: - lang: typescript label: getButlerTasks source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.butler.getButlerTasks(); // Handle the result console.log(result); } run(); - target: $["paths"]["/butler"]["post"] update: x-codeSamples: - lang: typescript label: startAllTasks source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.butler.startAllTasks(); // Handle the result console.log(result); } run(); - target: $["paths"]["/butler/{taskName}"]["delete"] update: x-codeSamples: - lang: typescript label: stopTask source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.butler.stopTask(PathParamTaskName.BackupDatabase); // Handle the result console.log(result); } run(); - target: $["paths"]["/butler/{taskName}"]["post"] update: x-codeSamples: - lang: typescript label: startTask source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { TaskName } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.butler.startTask(TaskName.CleanOldBundles); // Handle the result console.log(result); } run(); - target: $["paths"]["/clients"]["get"] update: x-codeSamples: - lang: typescript label: getAvailableClients source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getAvailableClients(); // Handle the result console.log(result); } run(); - target: $["paths"]["/companions"]["get"] update: x-codeSamples: - lang: typescript label: getCompanionsData source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.plex.getCompanionsData(); // Handle the result console.log(result); } run(); - target: $["paths"]["/devices"]["get"] update: x-codeSamples: - lang: typescript label: getDevices source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getDevices(); // Handle the result console.log(result); } run(); - target: $["paths"]["/friends"]["get"] update: x-codeSamples: - lang: typescript label: getUserFriends source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.plex.getUserFriends(); // Handle the result console.log(result); } run(); - target: $["paths"]["/geoip"]["get"] update: x-codeSamples: - lang: typescript label: getGeoData source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI(); async function run() { const result = await plexAPI.plex.getGeoData(); // Handle the result console.log(result); } run(); - target: $["paths"]["/home"]["get"] update: x-codeSamples: - lang: typescript label: getHomeData source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.plex.getHomeData(); // Handle the result console.log(result); } run(); - target: $["paths"]["/hubs"]["get"] update: x-codeSamples: - lang: typescript label: getGlobalHubs source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.hubs.getGlobalHubs(); // Handle the result console.log(result); } run(); - target: $["paths"]["/hubs/home/recentlyAdded"]["get"] update: x-codeSamples: - lang: typescript label: added source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.hubs.getRecentlyAdded({ contentDirectoryID: 470161, sectionID: 2, type: Type.TvShow, includeMeta: IncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/hubs/search"]["get"] update: x-codeSamples: - lang: typescript label: performSearch source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.search.performSearch("dylan", 5); // Handle the result console.log(result); } run(); - target: $["paths"]["/hubs/search/voice"]["get"] update: x-codeSamples: - lang: typescript label: performVoiceSearch source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.search.performVoiceSearch("dead+poop", 5); // Handle the result console.log(result); } run(); - target: $["paths"]["/hubs/sections/{sectionId}"]["get"] update: x-codeSamples: - lang: typescript label: getLibraryHubs source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.hubs.getLibraryHubs(6728.76); // Handle the result console.log(result); } run(); - target: $["paths"]["/identity"]["get"] update: x-codeSamples: - lang: typescript label: identity source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI(); async function run() { const result = await plexAPI.server.getServerIdentity(); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/all/top"]["get"] update: x-codeSamples: - lang: typescript label: getTopWatchedContent source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getTopWatchedContent(GetTopWatchedContentQueryParamType.TvShow, 1); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/hashes"]["get"] update: x-codeSamples: - lang: typescript label: getFileHash source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getFileHash("file://C:\Image.png&type=13"); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/metadata/{ratingKey}"]["get"] update: x-codeSamples: - lang: typescript label: key source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getMetaDataByRatingKey(9518); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"] update: x-codeSamples: - lang: typescript label: image source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.media.getBannerImage({ ratingKey: 9518, width: 396, height: 396, minSize: 1, upscale: 1, xPlexToken: "CV5xoxjTpFKUzBTShsaf", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"] update: x-codeSamples: - lang: typescript label: getMetadataChildren source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getMetadataChildren(1539.15, "Stream"); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"] update: x-codeSamples: - lang: typescript label: image source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.media.getThumbImage({ ratingKey: 9518, width: 396, height: 396, minSize: 1, upscale: 1, xPlexToken: "CV5xoxjTpFKUzBTShsaf", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/onDeck"]["get"] update: x-codeSamples: - lang: typescript label: getOnDeck source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getOnDeck(); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/recentlyAdded"]["get"] update: x-codeSamples: - lang: typescript label: library source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getRecentlyAddedLibrary({ contentDirectoryID: 2, pinnedContentDirectoryID: [ 3, 5, 7, 13, 12, 1, 6, 14, 2, 10, 16, 17, ], sectionID: 2, type: QueryParamType.TvShow, includeMeta: QueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/search"]["get"] update: x-codeSamples: - lang: typescript label: libraries source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { QueryParamIncludeCollections, QueryParamIncludeExternalMedia, SearchTypes } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getSearchAllLibraries({ query: "", clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", searchTypes: [ SearchTypes.People, ], includeCollections: QueryParamIncludeCollections.Enable, includeExternalMedia: QueryParamIncludeExternalMedia.Enable, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections"]["get"] update: x-codeSamples: - lang: typescript label: libraries source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getAllLibraries(); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/watchlist/{filter}"]["get"] update: x-codeSamples: - lang: typescript label: list source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.watchlist.getWatchList({ filter: Filter.Available, xPlexContainerStart: 0, xPlexContainerSize: 50, xPlexToken: "CV5xoxjTpFKUzBTShsaf", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/{sectionKey}"]["delete"] update: x-codeSamples: - lang: typescript label: deleteLibrary source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.deleteLibrary(9518); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/{sectionKey}"]["get"] update: x-codeSamples: - lang: typescript label: details source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getLibraryDetails(9518); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"] update: x-codeSamples: - lang: typescript label: metadata source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { Force } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getRefreshLibraryMetadata(9518, Force.One); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/{sectionKey}/search"]["get"] update: x-codeSamples: - lang: typescript label: library source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getSearchLibrary(9518, GetSearchLibraryQueryParamType.TvShow); // Handle the result console.log(result); } run(); - target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"] update: x-codeSamples: - lang: typescript label: items source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { GetLibraryItemsQueryParamIncludeMeta, GetLibraryItemsQueryParamType, IncludeGuids, Tag, } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.library.getLibraryItems({ tag: Tag.Edition, includeGuids: IncludeGuids.Enable, type: GetLibraryItemsQueryParamType.TvShow, sectionKey: 9518, includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/log"]["get"] update: x-codeSamples: - lang: typescript label: logLine source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { Level } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.log.logLine(Level.Three, "Test log message", "Postman"); // Handle the result console.log(result); } run(); - target: $["paths"]["/log"]["post"] update: x-codeSamples: - lang: typescript label: logMultiLine source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.log.logMultiLine("level=4&message=Test%20message%201&source=postman\n" + "level=3&message=Test%20message%202&source=postman\n" + "level=1&message=Test%20message%203&source=postman"); // Handle the result console.log(result); } run(); - target: $["paths"]["/log/networked"]["get"] update: x-codeSamples: - lang: typescript label: enablePaperTrail source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.log.enablePaperTrail(); // Handle the result console.log(result); } run(); - target: $["paths"]["/media/providers"]["get"] update: x-codeSamples: - lang: typescript label: providers source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getMediaProviders("CV5xoxjTpFKUzBTShsaf"); // Handle the result console.log(result); } run(); - target: $["paths"]["/myplex/account"]["get"] update: x-codeSamples: - lang: typescript label: getMyPlexAccount source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getMyPlexAccount(); // Handle the result console.log(result); } run(); - target: $["paths"]["/photo/:/transcode"]["get"] update: x-codeSamples: - lang: typescript label: getResizedPhoto source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getResizedPhoto({ width: 110, height: 165, opacity: 100, blur: 0, minSize: MinSize.One, upscale: Upscale.One, url: "/library/metadata/49564/thumb/1654258204", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/pins"]["post"] update: x-codeSamples: - lang: typescript label: getPin source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI(); async function run() { const result = await plexAPI.plex.getPin({ clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", clientName: "Plex for Roku", deviceNickname: "Roku 3", clientVersion: "2.4.1", platform: "Roku", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/pins/{pinID}"]["get"] update: x-codeSamples: - lang: typescript label: getTokenByPinId source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI(); async function run() { const result = await plexAPI.plex.getTokenByPinId({ pinID: 408895, clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", clientName: "Plex for Roku", deviceNickname: "Roku 3", clientVersion: "2.4.1", platform: "Roku", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists"]["get"] update: x-codeSamples: - lang: typescript label: getPlaylists source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.getPlaylists(); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists"]["post"] update: x-codeSamples: - lang: typescript label: createPlaylist source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.createPlaylist({ title: "", type: CreatePlaylistQueryParamType.Photo, smart: Smart.One, uri: "https://hoarse-testing.info/", }); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/upload"]["post"] update: x-codeSamples: - lang: typescript label: uploadPlaylist source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.uploadPlaylist("/home/barkley/playlist.m3u", QueryParamForce.Zero, 1); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}"]["delete"] update: x-codeSamples: - lang: typescript label: deletePlaylist source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.deletePlaylist(216.22); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}"]["get"] update: x-codeSamples: - lang: typescript label: getPlaylist source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.getPlaylist(4109.48); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}"]["put"] update: x-codeSamples: - lang: typescript label: updatePlaylist source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.updatePlaylist(3915.00); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}/items"]["delete"] update: x-codeSamples: - lang: typescript label: clearPlaylistContents source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.clearPlaylistContents(1893.18); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}/items"]["get"] update: x-codeSamples: - lang: typescript label: getPlaylistContents source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.getPlaylistContents(5004.46, GetPlaylistContentsQueryParamType.TvShow); // Handle the result console.log(result); } run(); - target: $["paths"]["/playlists/{playlistID}/items"]["put"] update: x-codeSamples: - lang: typescript label: addPlaylistContents source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.playlists.addPlaylistContents(8502.00, "server://12345/com.plexapp.plugins.library/library/metadata/1", 123); // Handle the result console.log(result); } run(); - target: $["paths"]["/resources"]["get"] update: x-codeSamples: - lang: typescript label: resources source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.plex.getServerResources("3381b62b-9ab7-4e37-827b-203e9809eb58", IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable); // Handle the result console.log(result); } run(); - target: $["paths"]["/search"]["get"] update: x-codeSamples: - lang: typescript label: getSearchResults source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.search.getSearchResults("110"); // Handle the result console.log(result); } run(); - target: $["paths"]["/security/resources"]["get"] update: x-codeSamples: - lang: typescript label: getSourceConnectionInformation source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.authentication.getSourceConnectionInformation("provider://provider-identifier"); // Handle the result console.log(result); } run(); - target: $["paths"]["/security/token"]["get"] update: x-codeSamples: - lang: typescript label: getTransientToken source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.authentication.getTransientToken(GetTransientTokenQueryParamType.Delegation, Scope.All); // Handle the result console.log(result); } run(); - target: $["paths"]["/servers"]["get"] update: x-codeSamples: - lang: typescript label: getServerList source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.server.getServerList(); // Handle the result console.log(result); } run(); - target: $["paths"]["/statistics/bandwidth"]["get"] update: x-codeSamples: - lang: typescript label: getBandwidthStatistics source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.statistics.getBandwidthStatistics(4); // Handle the result console.log(result); } run(); - target: $["paths"]["/statistics/media"]["get"] update: x-codeSamples: - lang: typescript label: getStatistics source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.statistics.getStatistics(4); // Handle the result console.log(result); } run(); - target: $["paths"]["/statistics/resources"]["get"] update: x-codeSamples: - lang: typescript label: getResourcesStatistics source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.statistics.getResourcesStatistics(4); // Handle the result console.log(result); } run(); - target: $["paths"]["/status/sessions"]["get"] update: x-codeSamples: - lang: typescript label: getSessions source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.sessions.getSessions(); // Handle the result console.log(result); } run(); - target: $["paths"]["/status/sessions/history/all"]["get"] update: x-codeSamples: - lang: typescript label: getSessionHistory source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.sessions.getSessionHistory("viewedAt:desc", 1, {}, 12); // Handle the result console.log(result); } run(); - target: $["paths"]["/transcode/sessions"]["get"] update: x-codeSamples: - lang: typescript label: getTranscodeSessions source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.sessions.getTranscodeSessions(); // Handle the result console.log(result); } run(); - target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"] update: x-codeSamples: - lang: typescript label: stopTranscodeSession source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.sessions.stopTranscodeSession("zz7llzqlx8w9vnrsbnwhbmep"); // Handle the result console.log(result); } run(); - target: $["paths"]["/updater/apply"]["put"] update: x-codeSamples: - lang: typescript label: applyUpdates source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.updater.applyUpdates(Tonight.One, Skip.One); // Handle the result console.log(result); } run(); - target: $["paths"]["/updater/check"]["put"] update: x-codeSamples: - lang: typescript label: checkForUpdates source: |- import { PlexAPI } from "@lukehagar/plexjs"; import { Download } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.updater.checkForUpdates(Download.One); // Handle the result console.log(result); } run(); - target: $["paths"]["/updater/status"]["get"] update: x-codeSamples: - lang: typescript label: getUpdateStatus source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.updater.getUpdateStatus(); // Handle the result console.log(result); } run(); - target: $["paths"]["/user"]["get"] update: x-codeSamples: - lang: typescript label: getTokenDetails source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.authentication.getTokenDetails(); // Handle the result console.log(result); } run(); - target: $["paths"]["/users/signin"]["post"] update: x-codeSamples: - lang: typescript label: data source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI(); async function run() { const result = await plexAPI.authentication.postUsersSignInData({ clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", clientName: "Plex for Roku", deviceNickname: "Roku 3", clientVersion: "2.4.1", platform: "Roku", requestBody: { login: "username@email.com", password: "password123", verificationCode: "123456", }, }); // Handle the result console.log(result); } run(); - target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"] update: x-codeSamples: - lang: typescript label: startUniversalTranscode source: |- import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", }); async function run() { const result = await plexAPI.video.startUniversalTranscode({ hasMDE: 1, path: "/library/metadata/23409", mediaIndex: 0, partIndex: 0, protocol: "hls", fastSeek: 0, directPlay: 0, directStream: 0, subtitleSize: 100, subtites: "burn", audioBoost: 100, location: "lan", mediaBufferSize: 102400, session: "zvcage8b7rkioqcm8f4uns4c", addDebugOverlay: 0, autoAdjustQuality: 0, }); // Handle the result console.log(result); } run();