From 1cfbd17f28252f54e751066f275a448fada61bf1 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 2 Oct 2024 02:30:07 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 --- .speakeasy/gen.lock | 47 +- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 10 +- FUNCTIONS.md | 10 +- README.md | 138 +--- RELEASES.md | 12 +- USAGE.md | 10 +- codeSamples.yaml | 754 +++++++++--------- .../operations/getbannerimagerequest.md | 2 +- .../operations/getlibrarydetailsrequest.md | 4 +- .../operations/getlibraryitemsrequest.md | 4 +- .../operations/getmediaprovidersrequest.md | 6 +- .../getmetadatachildrenmediacontainer.md | 2 +- .../operations/getmetadatachildrenmetadata.md | 4 +- .../operations/getmetadatachildrenresponse.md | 2 +- .../getmetadatachildrenresponsebody.md | 2 +- docs/sdk/models/operations/getpinglobals.md | 14 +- docs/sdk/models/operations/getpinrequest.md | 16 +- .../getrefreshlibrarymetadatarequest.md | 6 +- .../operations/getserverresourcesglobals.md | 6 +- .../operations/getserverresourcesrequest.md | 12 +- .../models/operations/getthumbimagerequest.md | 2 +- .../operations/gettokenbypinidglobals.md | 14 +- .../operations/gettokenbypinidrequest.md | 16 +- .../operations/gettopwatchedcontentrequest.md | 6 +- .../models/operations/getwatchlistrequest.md | 2 +- .../operations/postuserssignindataglobals.md | 14 +- .../operations/postuserssignindatarequest.md | 16 +- docs/sdks/activities/README.md | 40 +- docs/sdks/authentication/README.md | 80 +- docs/sdks/butler/README.md | 100 +-- docs/sdks/hubs/README.md | 60 +- docs/sdks/library/README.md | 244 +++--- docs/sdks/log/README.md | 60 +- docs/sdks/media/README.md | 100 +-- docs/sdks/playlists/README.md | 180 ++--- docs/sdks/plex/README.md | 146 ++-- docs/sdks/search/README.md | 60 +- docs/sdks/server/README.md | 182 ++--- docs/sdks/sessions/README.md | 80 +- docs/sdks/statistics/README.md | 60 +- docs/sdks/updater/README.md | 60 +- docs/sdks/video/README.md | 40 +- docs/sdks/watchlist/README.md | 20 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/funcs/activitiesCancelServerActivities.ts | 14 +- src/funcs/activitiesGetServerActivities.ts | 14 +- ...nticationGetSourceConnectionInformation.ts | 14 +- src/funcs/authenticationGetTokenDetails.ts | 14 +- src/funcs/authenticationGetTransientToken.ts | 14 +- .../authenticationPostUsersSignInData.ts | 76 +- src/funcs/butlerGetButlerTasks.ts | 14 +- src/funcs/butlerStartAllTasks.ts | 14 +- src/funcs/butlerStartTask.ts | 14 +- src/funcs/butlerStopAllTasks.ts | 14 +- src/funcs/butlerStopTask.ts | 14 +- src/funcs/hubsGetGlobalHubs.ts | 14 +- src/funcs/hubsGetLibraryHubs.ts | 14 +- src/funcs/hubsGetRecentlyAdded.ts | 14 +- src/funcs/libraryDeleteLibrary.ts | 14 +- src/funcs/libraryGetAllLibraries.ts | 14 +- src/funcs/libraryGetFileHash.ts | 14 +- src/funcs/libraryGetLibraryDetails.ts | 16 +- src/funcs/libraryGetLibraryItems.ts | 14 +- src/funcs/libraryGetMetaDataByRatingKey.ts | 14 +- src/funcs/libraryGetMetadataChildren.ts | 14 +- src/funcs/libraryGetOnDeck.ts | 14 +- src/funcs/libraryGetRecentlyAddedLibrary.ts | 14 +- src/funcs/libraryGetRefreshLibraryMetadata.ts | 16 +- src/funcs/libraryGetSearchLibrary.ts | 14 +- src/funcs/libraryGetTopWatchedContent.ts | 16 +- src/funcs/logEnablePaperTrail.ts | 14 +- src/funcs/logLogLine.ts | 14 +- src/funcs/logLogMultiLine.ts | 14 +- src/funcs/mediaGetBannerImage.ts | 19 +- src/funcs/mediaGetThumbImage.ts | 19 +- src/funcs/mediaMarkPlayed.ts | 14 +- src/funcs/mediaMarkUnplayed.ts | 14 +- src/funcs/mediaUpdatePlayProgress.ts | 14 +- src/funcs/playlistsAddPlaylistContents.ts | 14 +- src/funcs/playlistsClearPlaylistContents.ts | 14 +- src/funcs/playlistsCreatePlaylist.ts | 14 +- src/funcs/playlistsDeletePlaylist.ts | 14 +- src/funcs/playlistsGetPlaylist.ts | 14 +- src/funcs/playlistsGetPlaylistContents.ts | 14 +- src/funcs/playlistsGetPlaylists.ts | 14 +- src/funcs/playlistsUpdatePlaylist.ts | 14 +- src/funcs/playlistsUploadPlaylist.ts | 14 +- src/funcs/plexGetCompanionsData.ts | 14 +- src/funcs/plexGetGeoData.ts | 14 +- src/funcs/plexGetHomeData.ts | 14 +- src/funcs/plexGetPin.ts | 72 +- src/funcs/plexGetServerResources.ts | 28 +- src/funcs/plexGetTokenByPinId.ts | 76 +- src/funcs/plexGetUserFriends.ts | 14 +- src/funcs/searchGetSearchResults.ts | 14 +- src/funcs/searchPerformSearch.ts | 14 +- src/funcs/searchPerformVoiceSearch.ts | 14 +- src/funcs/serverGetAvailableClients.ts | 14 +- src/funcs/serverGetDevices.ts | 14 +- src/funcs/serverGetMediaProviders.ts | 25 +- src/funcs/serverGetMyPlexAccount.ts | 14 +- src/funcs/serverGetResizedPhoto.ts | 14 +- src/funcs/serverGetServerCapabilities.ts | 14 +- src/funcs/serverGetServerIdentity.ts | 14 +- src/funcs/serverGetServerList.ts | 14 +- src/funcs/serverGetServerPreferences.ts | 14 +- src/funcs/sessionsGetSessionHistory.ts | 14 +- src/funcs/sessionsGetSessions.ts | 14 +- src/funcs/sessionsGetTranscodeSessions.ts | 14 +- src/funcs/sessionsStopTranscodeSession.ts | 14 +- src/funcs/statisticsGetBandwidthStatistics.ts | 14 +- src/funcs/statisticsGetResourcesStatistics.ts | 14 +- src/funcs/statisticsGetStatistics.ts | 14 +- src/funcs/updaterApplyUpdates.ts | 14 +- src/funcs/updaterCheckForUpdates.ts | 14 +- src/funcs/updaterGetUpdateStatus.ts | 14 +- src/funcs/videoGetTimeline.ts | 14 +- src/funcs/videoStartUniversalTranscode.ts | 14 +- src/funcs/watchlistGetWatchList.ts | 19 +- src/lib/config.ts | 12 +- src/sdk/models/operations/getbannerimage.ts | 2 +- .../models/operations/getlibrarydetails.ts | 20 +- src/sdk/models/operations/getlibraryitems.ts | 20 +- .../models/operations/getmediaproviders.ts | 2 +- src/sdk/models/operations/getpin.ts | 68 +- .../operations/getrefreshlibrarymetadata.ts | 14 +- .../models/operations/getserverresources.ts | 4 +- src/sdk/models/operations/getthumbimage.ts | 2 +- src/sdk/models/operations/gettokenbypinid.ts | 68 +- .../models/operations/gettopwatchedcontent.ts | 18 +- src/sdk/models/operations/getwatchlist.ts | 2 +- .../models/operations/postuserssignindata.ts | 68 +- 135 files changed, 2545 insertions(+), 1686 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index f7b1e87d..6d4ba306 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 16f22cbf-f23f-4419-8924-3a4b06381947 management: - docChecksum: 8211d52d43d85f28d036343732de833a + docChecksum: 649b155561aeea4d804f8713e7b2dcac docVersion: 0.0.3 speakeasyVersion: 1.405.6 generationVersion: 2.428.1 - releaseVersion: 0.24.1 - configChecksum: 3e2876ee2c8211e7dbed88c3d78e86ed + releaseVersion: 0.24.2 + configChecksum: ace0d2819165b8537063b42c658d29d9 repoURL: https://github.com/LukeHagar/plexjs.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/plexjs @@ -1182,6 +1182,8 @@ examples: parameters: query: X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" + header: + X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" responses: "401": application/json: {"errors": []} @@ -1241,6 +1243,8 @@ examples: minSize: 1 upscale: 1 X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" + header: + X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" responses: "401": application/json: {"errors": []} @@ -1258,6 +1262,8 @@ examples: minSize: 1 upscale: 1 X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" + header: + X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" responses: "401": application/json: {"errors": []} @@ -1421,6 +1427,21 @@ examples: application/json: [] "400": application/json: {"errors": []} + "": + parameters: + query: + includeHttps: 1 + includeRelay: 1 + includeIPv6: 1 + header: + X-Plex-Client-Identifier: "3381b62b-9ab7-4e37-827b-203e9809eb58" + responses: + "200": + application/json: [] + "400": + application/json: {"errors": [{"code": 1000, "message": "X-Plex-Client-Identifier is missing", "status": 400}, {"code": 1000, "message": "X-Plex-Client-Identifier is missing", "status": 400}]} + "401": + application/json: {"errors": [{"code": 1001, "message": "User could not be authenticated", "status": 401}]} getPin: "": parameters: @@ -1430,6 +1451,12 @@ examples: X-Plex-Device: "Linux" X-Plex-Version: "4.133.0" X-Plex-Platform: "Chrome" + header: + X-Plex-Client-Identifier: "3381b62b-9ab7-4e37-827b-203e9809eb58" + X-Plex-Product: "Plex for Roku" + X-Plex-Device: "Roku 3" + X-Plex-Version: "2.4.1" + X-Plex-Platform: "Roku" responses: "200": application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null} @@ -1448,6 +1475,12 @@ examples: X-Plex-Device: "Linux" X-Plex-Version: "4.133.0" X-Plex-Platform: "Chrome" + header: + X-Plex-Client-Identifier: "3381b62b-9ab7-4e37-827b-203e9809eb58" + X-Plex-Product: "Plex for Roku" + X-Plex-Device: "Roku 3" + X-Plex-Version: "2.4.1" + X-Plex-Platform: "Roku" responses: "200": application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null} @@ -1712,6 +1745,8 @@ examples: X-Plex-Container-Start: 0 X-Plex-Container-Size: 50 X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" + header: + X-Plex-Token: "CV5xoxjTpFKUzBTShsaf" responses: "401": application/json: {"errors": []} @@ -1906,6 +1941,12 @@ examples: X-Plex-Device: "Linux" X-Plex-Version: "4.133.0" X-Plex-Platform: "Chrome" + header: + X-Plex-Client-Identifier: "3381b62b-9ab7-4e37-827b-203e9809eb58" + X-Plex-Product: "Plex for Roku" + X-Plex-Device: "Roku 3" + X-Plex-Version: "2.4.1" + X-Plex-Platform: "Roku" requestBody: application/x-www-form-urlencoded: {"login": "username@email.com", "password": "password123", "verificationCode": "123456"} responses: diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 67f8e35b..f6d78ce0 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true typescript: - version: 0.24.1 + version: 0.24.2 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 5ab2d3e8..c8dbeacc 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -9,8 +9,8 @@ sources: - main plexapi: sourceNamespace: plexapi - sourceRevisionDigest: sha256:b377f79289070406b0d4adcf59fa6886c6c90cb13a7893c07b44cae956ee25e4 - sourceBlobDigest: sha256:92072097f693005146db1ceb5728eee08693d61bb5578b26c32dcbe1cc32927f + sourceRevisionDigest: sha256:b1e231bd781f352738612b0158382ba51cfac32e97c23d9e4913aab5501e9529 + sourceBlobDigest: sha256:8ce05d5965182eb3fe9376715c269b9e1c7f3e2d90273c175a4181735f41daa0 tags: - latest - main @@ -18,10 +18,10 @@ targets: plexjs: source: plexapi sourceNamespace: plexapi - sourceRevisionDigest: sha256:b377f79289070406b0d4adcf59fa6886c6c90cb13a7893c07b44cae956ee25e4 - sourceBlobDigest: sha256:92072097f693005146db1ceb5728eee08693d61bb5578b26c32dcbe1cc32927f + sourceRevisionDigest: sha256:b1e231bd781f352738612b0158382ba51cfac32e97c23d9e4913aab5501e9529 + sourceBlobDigest: sha256:8ce05d5965182eb3fe9376715c269b9e1c7f3e2d90273c175a4181735f41daa0 codeSamplesNamespace: code-samples-typescript-plexjs - codeSamplesRevisionDigest: sha256:d2b20286cc2cb6f6ffcd416a467a29872b97bcc88d2e1ffe51e681666ef7ed17 + codeSamplesRevisionDigest: sha256:ca55aa5571fbfbfc191350456c0d8c4e08f1ceb5444f96b41617536651323250 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/FUNCTIONS.md b/FUNCTIONS.md index a5259b6e..2181cc2b 100644 --- a/FUNCTIONS.md +++ b/FUNCTIONS.md @@ -27,11 +27,11 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/README.md b/README.md index 2de1e5f8..f353799d 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) * [Standalone functions](#standalone-functions) -* [Global Parameters](#global-parameters) * [Retries](#retries) * [Error Handling](#error-handling) * [Server Selection](#server-selection) @@ -98,11 +97,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -283,11 +282,11 @@ import { const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -347,11 +346,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverIdx: 0, accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -382,11 +381,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverURL: "{protocol}://{ip}:{port}", accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -408,11 +407,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -495,11 +494,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -615,63 +614,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - -## Global Parameters - -Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed. - -For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. - - -### Available Globals - -The following global parameters are available. - -| Name | Type | Required | Description | -| ---- | ---- |:--------:| ----------- | -| clientID | string | | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | -| clientName | string | | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | -| clientVersion | string | | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | -| clientPlatform | string | | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | -| deviceName | string | | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | - - -### Example - -```typescript -import { PlexAPI } from "@lukehagar/plexjs"; -import { - IncludeHttps, - IncludeIPv6, - IncludeRelay, -} from "@lukehagar/plexjs/sdk/models/operations"; - -const plexAPI = new PlexAPI({ - accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", -}); - -async function run() { - const result = await plexAPI.plex.getServerResources( - IncludeHttps.Enable, - IncludeRelay.Enable, - IncludeIPv6.Enable, - "gcgzw5rz2xovp84b4vha3a40", - ); - - // Handle the result - console.log(result); -} - -run(); - -``` - - ## Retries @@ -683,11 +625,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -728,11 +670,11 @@ const plexAPI = new PlexAPI({ retryConnectionErrors: false, }, accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/RELEASES.md b/RELEASES.md index dbf6032e..6fb44dd6 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1088,4 +1088,14 @@ Based on: ### Generated - [typescript v0.24.1] . ### Releases -- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - . \ No newline at end of file +- [NPM v0.24.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.1 - . + +## 2024-10-02 02:28:25 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.24.2] . +### Releases +- [NPM v0.24.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.24.2 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 07ed5530..555f615b 100644 --- a/USAGE.md +++ b/USAGE.md @@ -4,11 +4,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/codeSamples.yaml b/codeSamples.yaml index 95785c7f..e01fe1e6 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -13,11 +13,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -38,11 +38,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -63,11 +63,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -88,11 +88,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -114,11 +114,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -150,11 +150,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -175,11 +175,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -200,11 +200,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -225,11 +225,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -250,11 +250,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -275,11 +275,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -301,11 +301,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -327,11 +327,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -352,11 +352,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -377,11 +377,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -402,11 +402,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -427,11 +427,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -451,11 +451,11 @@ actions: import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -476,11 +476,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -501,11 +501,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -527,11 +527,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -559,11 +559,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -584,11 +584,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -609,11 +609,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -633,11 +633,11 @@ actions: import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -659,11 +659,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -684,11 +684,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -709,11 +709,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -734,11 +734,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -766,11 +766,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -791,11 +791,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -823,11 +823,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -849,11 +849,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -895,11 +895,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -921,11 +921,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -951,11 +951,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -976,11 +976,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1002,11 +1002,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1028,11 +1028,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1059,19 +1059,19 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { const result = await plexAPI.library.getLibraryItems({ - sectionKey: 9518, tag: Tag.Edition, includeGuids: IncludeGuids.Enable, type: GetLibraryItemsQueryParamType.TvShow, + sectionKey: 9518, includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, @@ -1093,11 +1093,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1118,11 +1118,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1145,11 +1145,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1170,11 +1170,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1195,11 +1195,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1221,11 +1221,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1253,11 +1253,11 @@ actions: import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1277,11 +1277,11 @@ actions: import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1304,11 +1304,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1330,11 +1330,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1361,11 +1361,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1386,11 +1386,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1411,11 +1411,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1436,11 +1436,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1461,11 +1461,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1487,11 +1487,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1512,11 +1512,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1538,15 +1538,15 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { - const result = await plexAPI.plex.getServerResources(IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "gcgzw5rz2xovp84b4vha3a40"); + const result = await plexAPI.plex.getServerResources(IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "3381b62b-9ab7-4e37-827b-203e9809eb58"); // Handle the result console.log(result); @@ -1563,11 +1563,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1588,11 +1588,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1614,11 +1614,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1639,11 +1639,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1664,11 +1664,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1689,11 +1689,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1714,11 +1714,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1739,11 +1739,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1764,11 +1764,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1789,11 +1789,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1814,11 +1814,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1840,11 +1840,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1866,11 +1866,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1891,11 +1891,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1916,11 +1916,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1940,11 +1940,11 @@ actions: import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1971,11 +1971,11 @@ actions: const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdk/models/operations/getbannerimagerequest.md b/docs/sdk/models/operations/getbannerimagerequest.md index 44f02679..a508fede 100644 --- a/docs/sdk/models/operations/getbannerimagerequest.md +++ b/docs/sdk/models/operations/getbannerimagerequest.md @@ -24,4 +24,4 @@ let value: GetBannerImageRequest = { | `height` | *number* | :heavy_check_mark: | N/A | 396 | | `minSize` | *number* | :heavy_check_mark: | N/A | 1 | | `upscale` | *number* | :heavy_check_mark: | N/A | 1 | -| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file +| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file diff --git a/docs/sdk/models/operations/getlibrarydetailsrequest.md b/docs/sdk/models/operations/getlibrarydetailsrequest.md index b54a0402..3ab7980f 100644 --- a/docs/sdk/models/operations/getlibrarydetailsrequest.md +++ b/docs/sdk/models/operations/getlibrarydetailsrequest.md @@ -14,5 +14,5 @@ let value: GetLibraryDetailsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | -| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
| | \ No newline at end of file +| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
| | +| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getlibraryitemsrequest.md b/docs/sdk/models/operations/getlibraryitemsrequest.md index a5ac4a7f..2302a810 100644 --- a/docs/sdk/models/operations/getlibraryitemsrequest.md +++ b/docs/sdk/models/operations/getlibraryitemsrequest.md @@ -12,10 +12,10 @@ import { } from "@lukehagar/plexjs/sdk/models/operations"; let value: GetLibraryItemsRequest = { - sectionKey: 9518, tag: Tag.FirstCharacter, includeGuids: IncludeGuids.Enable, type: GetLibraryItemsQueryParamType.TvShow, + sectionKey: 9518, includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, @@ -26,10 +26,10 @@ let value: GetLibraryItemsRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | | `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | | | `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response
| 1 | | `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
| 2 | +| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | | `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response
| 1 | | `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.
If the number of items exceeds the limit, the response will be paginated.
By default this is 0
| 0 | | `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.
If the number of items exceeds the limit, the response will be paginated.
By default this is 50
| 50 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getmediaprovidersrequest.md b/docs/sdk/models/operations/getmediaprovidersrequest.md index a049d79c..699781ca 100644 --- a/docs/sdk/models/operations/getmediaprovidersrequest.md +++ b/docs/sdk/models/operations/getmediaprovidersrequest.md @@ -12,6 +12,6 @@ let value: GetMediaProvidersRequest = { ## Fields -| Field | Type | Required | Description | Example | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file diff --git a/docs/sdk/models/operations/getmetadatachildrenmediacontainer.md b/docs/sdk/models/operations/getmetadatachildrenmediacontainer.md index 3a8b30e1..41dcf566 100644 --- a/docs/sdk/models/operations/getmetadatachildrenmediacontainer.md +++ b/docs/sdk/models/operations/getmetadatachildrenmediacontainer.md @@ -50,7 +50,7 @@ let value: GetMetadataChildrenMediaContainer = { parentKey: "/library/metadata/30072", parentTitle: "Reacher", summary: - "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.", index: 2, parentIndex: 1, viewCount: 11, diff --git a/docs/sdk/models/operations/getmetadatachildrenmetadata.md b/docs/sdk/models/operations/getmetadatachildrenmetadata.md index 876a8e31..8579d76a 100644 --- a/docs/sdk/models/operations/getmetadatachildrenmetadata.md +++ b/docs/sdk/models/operations/getmetadatachildrenmetadata.md @@ -17,7 +17,7 @@ let value: GetMetadataChildrenMetadata = { parentKey: "/library/metadata/30072", parentTitle: "Reacher", summary: - "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.", index: 2, parentIndex: 1, viewCount: 11, @@ -51,7 +51,7 @@ let value: GetMetadataChildrenMetadata = { | `title` | *string* | :heavy_minus_sign: | N/A | Season 2 | | `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/30072 | | `parentTitle` | *string* | :heavy_minus_sign: | N/A | Reacher | -| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. | +| `summary` | *string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. | | `index` | *number* | :heavy_minus_sign: | N/A | 2 | | `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 | | `viewCount` | *number* | :heavy_minus_sign: | N/A | 11 | diff --git a/docs/sdk/models/operations/getmetadatachildrenresponse.md b/docs/sdk/models/operations/getmetadatachildrenresponse.md index 11b1b408..da65fac2 100644 --- a/docs/sdk/models/operations/getmetadatachildrenresponse.md +++ b/docs/sdk/models/operations/getmetadatachildrenresponse.md @@ -57,7 +57,7 @@ let value: GetMetadataChildrenResponse = { parentKey: "/library/metadata/30072", parentTitle: "Reacher", summary: - "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.", index: 2, parentIndex: 1, viewCount: 11, diff --git a/docs/sdk/models/operations/getmetadatachildrenresponsebody.md b/docs/sdk/models/operations/getmetadatachildrenresponsebody.md index 6db8d3eb..1c87aa68 100644 --- a/docs/sdk/models/operations/getmetadatachildrenresponsebody.md +++ b/docs/sdk/models/operations/getmetadatachildrenresponsebody.md @@ -53,7 +53,7 @@ let value: GetMetadataChildrenResponseBody = { parentKey: "/library/metadata/30072", parentTitle: "Reacher", summary: - "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge.", index: 2, parentIndex: 1, viewCount: 11, diff --git a/docs/sdk/models/operations/getpinglobals.md b/docs/sdk/models/operations/getpinglobals.md index 54274717..f7fa6675 100644 --- a/docs/sdk/models/operations/getpinglobals.md +++ b/docs/sdk/models/operations/getpinglobals.md @@ -10,10 +10,10 @@ let value: GetPinGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | \ No newline at end of file diff --git a/docs/sdk/models/operations/getpinrequest.md b/docs/sdk/models/operations/getpinrequest.md index 0309d3c4..fc08a18f 100644 --- a/docs/sdk/models/operations/getpinrequest.md +++ b/docs/sdk/models/operations/getpinrequest.md @@ -10,11 +10,11 @@ let value: GetPinRequest = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | \ No newline at end of file diff --git a/docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md b/docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md index d41ca89f..8d977e6e 100644 --- a/docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md +++ b/docs/sdk/models/operations/getrefreshlibrarymetadatarequest.md @@ -6,8 +6,8 @@ import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations"; let value: GetRefreshLibraryMetadataRequest = { - sectionKey: 9518, force: Force.One, + sectionKey: 9518, }; ``` @@ -15,5 +15,5 @@ let value: GetRefreshLibraryMetadataRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | -| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 | \ No newline at end of file +| `force` | [operations.Force](../../../sdk/models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 | +| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library.
Note: This is unique in the context of the Plex server.
| 9518 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getserverresourcesglobals.md b/docs/sdk/models/operations/getserverresourcesglobals.md index 595b9e3a..f9d35ac9 100644 --- a/docs/sdk/models/operations/getserverresourcesglobals.md +++ b/docs/sdk/models/operations/getserverresourcesglobals.md @@ -10,6 +10,6 @@ let value: GetServerResourcesGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getserverresourcesrequest.md b/docs/sdk/models/operations/getserverresourcesrequest.md index 8870de86..edb401b9 100644 --- a/docs/sdk/models/operations/getserverresourcesrequest.md +++ b/docs/sdk/models/operations/getserverresourcesrequest.md @@ -14,9 +14,9 @@ let value: GetServerResourcesRequest = { ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | -| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `includeHttps` | [operations.IncludeHttps](../../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | +| `includeRelay` | [operations.IncludeRelay](../../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | +| `includeIPv6` | [operations.IncludeIPv6](../../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getthumbimagerequest.md b/docs/sdk/models/operations/getthumbimagerequest.md index 8c054b3a..37209964 100644 --- a/docs/sdk/models/operations/getthumbimagerequest.md +++ b/docs/sdk/models/operations/getthumbimagerequest.md @@ -24,4 +24,4 @@ let value: GetThumbImageRequest = { | `height` | *number* | :heavy_check_mark: | N/A | 396 | | `minSize` | *number* | :heavy_check_mark: | N/A | 1 | | `upscale` | *number* | :heavy_check_mark: | N/A | 1 | -| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file +| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file diff --git a/docs/sdk/models/operations/gettokenbypinidglobals.md b/docs/sdk/models/operations/gettokenbypinidglobals.md index beb165ef..df6501d6 100644 --- a/docs/sdk/models/operations/gettokenbypinidglobals.md +++ b/docs/sdk/models/operations/gettokenbypinidglobals.md @@ -10,10 +10,10 @@ let value: GetTokenByPinIdGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | \ No newline at end of file diff --git a/docs/sdk/models/operations/gettokenbypinidrequest.md b/docs/sdk/models/operations/gettokenbypinidrequest.md index 71c7c4b8..32c38a82 100644 --- a/docs/sdk/models/operations/gettokenbypinidrequest.md +++ b/docs/sdk/models/operations/gettokenbypinidrequest.md @@ -12,11 +12,11 @@ let value: GetTokenByPinIdRequest = { ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | \ No newline at end of file diff --git a/docs/sdk/models/operations/gettopwatchedcontentrequest.md b/docs/sdk/models/operations/gettopwatchedcontentrequest.md index 690dfd80..1785a8e1 100644 --- a/docs/sdk/models/operations/gettopwatchedcontentrequest.md +++ b/docs/sdk/models/operations/gettopwatchedcontentrequest.md @@ -6,8 +6,8 @@ import { GetTopWatchedContentQueryParamType, GetTopWatchedContentRequest } from "@lukehagar/plexjs/sdk/models/operations"; let value: GetTopWatchedContentRequest = { - type: GetTopWatchedContentQueryParamType.TvShow, includeGuids: 1, + type: GetTopWatchedContentQueryParamType.TvShow, }; ``` @@ -15,5 +15,5 @@ let value: GetTopWatchedContentRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
| 2 | -| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response
| 1 | \ No newline at end of file +| `includeGuids` | *number* | :heavy_minus_sign: | Adds the Guids object to the response
| 1 | +| `type` | [operations.GetTopWatchedContentQueryParamType](../../../sdk/models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
| 2 | \ No newline at end of file diff --git a/docs/sdk/models/operations/getwatchlistrequest.md b/docs/sdk/models/operations/getwatchlistrequest.md index 6c4ea96a..d0e3e163 100644 --- a/docs/sdk/models/operations/getwatchlistrequest.md +++ b/docs/sdk/models/operations/getwatchlistrequest.md @@ -25,4 +25,4 @@ let value: GetWatchListRequest = { | `includeExternalMedia` | [operations.IncludeExternalMedia](../../../sdk/models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results
| | | `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.
If the number of items exceeds the limit, the response will be paginated.
By default this is 0
| 0 | | `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.
If the number of items exceeds the limit, the response will be paginated.
By default this is 50
| 50 | -| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file +| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf | \ No newline at end of file diff --git a/docs/sdk/models/operations/postuserssignindataglobals.md b/docs/sdk/models/operations/postuserssignindataglobals.md index af101ef3..bf950ee3 100644 --- a/docs/sdk/models/operations/postuserssignindataglobals.md +++ b/docs/sdk/models/operations/postuserssignindataglobals.md @@ -10,10 +10,10 @@ let value: PostUsersSignInDataGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | \ No newline at end of file diff --git a/docs/sdk/models/operations/postuserssignindatarequest.md b/docs/sdk/models/operations/postuserssignindatarequest.md index fa8d7c15..dd72104b 100644 --- a/docs/sdk/models/operations/postuserssignindatarequest.md +++ b/docs/sdk/models/operations/postuserssignindatarequest.md @@ -16,11 +16,11 @@ let value: PostUsersSignInDataRequest = { ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | -| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) | Plex Web | -| `deviceName` | *string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) | Linux | -| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) | 4.133.0 | -| `clientPlatform` | *string* | :heavy_minus_sign: | The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | -| `requestBody` | [operations.PostUsersSignInDataRequestBody](../../../sdk/models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | +| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | +| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | +| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | +| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | +| `requestBody` | [operations.PostUsersSignInDataRequestBody](../../../sdk/models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 986e49b6..c71ec759 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -28,11 +28,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -57,11 +57,11 @@ import { activitiesGetServerActivities } from "@lukehagar/plexjs/funcs/activitie // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -111,11 +111,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -140,11 +140,11 @@ import { activitiesCancelServerActivities } from "@lukehagar/plexjs/funcs/activi // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md index 002e01bf..cf91bcd1 100644 --- a/docs/sdks/authentication/README.md +++ b/docs/sdks/authentication/README.md @@ -26,11 +26,11 @@ import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/mo const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -56,11 +56,11 @@ import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/mo // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -114,11 +114,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -143,11 +143,11 @@ import { authenticationGetSourceConnectionInformation } from "@lukehagar/plexjs/ // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -198,11 +198,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -227,11 +227,11 @@ import { authenticationGetTokenDetails } from "@lukehagar/plexjs/funcs/authentic // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -281,11 +281,11 @@ Sign in user with username and password and return user data with Plex authentic import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -315,11 +315,11 @@ import { authenticationPostUsersSignInData } from "@lukehagar/plexjs/funcs/authe // Use `PlexAPICore` for best tree-shaking performance. // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/butler/README.md b/docs/sdks/butler/README.md index b35ac789..651d79ae 100644 --- a/docs/sdks/butler/README.md +++ b/docs/sdks/butler/README.md @@ -25,11 +25,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -54,11 +54,11 @@ import { butlerGetButlerTasks } from "@lukehagar/plexjs/funcs/butlerGetButlerTas // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -113,11 +113,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -142,11 +142,11 @@ import { butlerStartAllTasks } from "@lukehagar/plexjs/funcs/butlerStartAllTasks // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -197,11 +197,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -226,11 +226,11 @@ import { butlerStopAllTasks } from "@lukehagar/plexjs/funcs/butlerStopAllTasks.j // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -286,11 +286,11 @@ import { TaskName } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -316,11 +316,11 @@ import { TaskName } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -373,11 +373,11 @@ import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -403,11 +403,11 @@ import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/hubs/README.md b/docs/sdks/hubs/README.md index 4774284b..738dfdcf 100644 --- a/docs/sdks/hubs/README.md +++ b/docs/sdks/hubs/README.md @@ -23,11 +23,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -52,11 +52,11 @@ import { hubsGetGlobalHubs } from "@lukehagar/plexjs/funcs/hubsGetGlobalHubs.js" // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -110,11 +110,11 @@ import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -147,11 +147,11 @@ import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -208,11 +208,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -237,11 +237,11 @@ import { hubsGetLibraryHubs } from "@lukehagar/plexjs/funcs/hubsGetLibraryHubs.j // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md index 767acc81..b33b1809 100644 --- a/docs/sdks/library/README.md +++ b/docs/sdks/library/README.md @@ -32,11 +32,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -61,11 +61,11 @@ import { libraryGetFileHash } from "@lukehagar/plexjs/funcs/libraryGetFileHash.j // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -119,11 +119,11 @@ import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/mod const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -170,11 +170,11 @@ import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/mod // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -252,11 +252,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -281,11 +281,11 @@ import { libraryGetAllLibraries } from "@lukehagar/plexjs/funcs/libraryGetAllLib // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -374,11 +374,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -403,11 +403,11 @@ import { libraryGetLibraryDetails } from "@lukehagar/plexjs/funcs/libraryGetLibr // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -459,11 +459,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -488,11 +488,11 @@ import { libraryDeleteLibrary } from "@lukehagar/plexjs/funcs/libraryDeleteLibra // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -569,19 +569,19 @@ import { const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { const result = await plexAPI.library.getLibraryItems({ - sectionKey: 9518, tag: Tag.Edition, includeGuids: IncludeGuids.Enable, type: GetLibraryItemsQueryParamType.TvShow, + sectionKey: 9518, includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, @@ -612,19 +612,19 @@ import { // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { const res = await libraryGetLibraryItems(plexAPI, { - sectionKey: 9518, tag: Tag.Edition, includeGuids: IncludeGuids.Enable, type: GetLibraryItemsQueryParamType.TvShow, + sectionKey: 9518, includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable, xPlexContainerStart: 0, xPlexContainerSize: 50, @@ -677,11 +677,11 @@ import { Force } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -707,11 +707,11 @@ import { Force } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -782,11 +782,11 @@ import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/ope const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -812,11 +812,11 @@ import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/ope // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -869,11 +869,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -898,11 +898,11 @@ import { libraryGetMetaDataByRatingKey } from "@lukehagar/plexjs/funcs/libraryGe // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -954,11 +954,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -983,11 +983,11 @@ import { libraryGetMetadataChildren } from "@lukehagar/plexjs/funcs/libraryGetMe // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1041,11 +1041,11 @@ import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1071,11 +1071,11 @@ import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1128,11 +1128,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -1157,11 +1157,11 @@ import { libraryGetOnDeck } from "@lukehagar/plexjs/funcs/libraryGetOnDeck.js"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md index bd195797..c0dcf0e6 100644 --- a/docs/sdks/log/README.md +++ b/docs/sdks/log/README.md @@ -25,11 +25,11 @@ import { Level } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -55,11 +55,11 @@ import { Level } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -133,11 +133,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -164,11 +164,11 @@ import { logLogMultiLine } from "@lukehagar/plexjs/funcs/logLogMultiLine.js"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -222,11 +222,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -251,11 +251,11 @@ import { logEnablePaperTrail } from "@lukehagar/plexjs/funcs/logEnablePaperTrail // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/media/README.md b/docs/sdks/media/README.md index 0896986d..bf0d246c 100644 --- a/docs/sdks/media/README.md +++ b/docs/sdks/media/README.md @@ -25,11 +25,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -54,11 +54,11 @@ import { mediaMarkPlayed } from "@lukehagar/plexjs/funcs/mediaMarkPlayed.js"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -109,11 +109,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -138,11 +138,11 @@ import { mediaMarkUnplayed } from "@lukehagar/plexjs/funcs/mediaMarkUnplayed.js" // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -194,11 +194,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -223,11 +223,11 @@ import { mediaUpdatePlayProgress } from "@lukehagar/plexjs/funcs/mediaUpdatePlay // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -280,11 +280,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -316,11 +316,11 @@ import { mediaGetBannerImage } from "@lukehagar/plexjs/funcs/mediaGetBannerImage // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -378,11 +378,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -414,11 +414,11 @@ import { mediaGetThumbImage } from "@lukehagar/plexjs/funcs/mediaGetThumbImage.j // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md index ae0eb911..d805145b 100644 --- a/docs/sdks/playlists/README.md +++ b/docs/sdks/playlists/README.md @@ -36,11 +36,11 @@ import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/model const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -71,11 +71,11 @@ import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/model // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -131,11 +131,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -160,11 +160,11 @@ import { playlistsGetPlaylists } from "@lukehagar/plexjs/funcs/playlistsGetPlayl // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -218,11 +218,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -247,11 +247,11 @@ import { playlistsGetPlaylist } from "@lukehagar/plexjs/funcs/playlistsGetPlayli // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -303,11 +303,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -332,11 +332,11 @@ import { playlistsDeletePlaylist } from "@lukehagar/plexjs/funcs/playlistsDelete // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -388,11 +388,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -417,11 +417,11 @@ import { playlistsUpdatePlaylist } from "@lukehagar/plexjs/funcs/playlistsUpdate // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -479,11 +479,11 @@ import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/ const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -509,11 +509,11 @@ import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/ // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -566,11 +566,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -595,11 +595,11 @@ import { playlistsClearPlaylistContents } from "@lukehagar/plexjs/funcs/playlist // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -652,11 +652,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -681,11 +681,11 @@ import { playlistsAddPlaylistContents } from "@lukehagar/plexjs/funcs/playlistsA // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -740,11 +740,11 @@ import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -770,11 +770,11 @@ import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md index 2c953db3..6334f302 100644 --- a/docs/sdks/plex/README.md +++ b/docs/sdks/plex/README.md @@ -27,11 +27,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -56,11 +56,11 @@ import { plexGetCompanionsData } from "@lukehagar/plexjs/funcs/plexGetCompanions // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -111,11 +111,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -140,11 +140,11 @@ import { plexGetUserFriends } from "@lukehagar/plexjs/funcs/plexGetUserFriends.j // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -194,11 +194,11 @@ Returns the geolocation and locale data of the caller import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -222,11 +222,11 @@ import { plexGetGeoData } from "@lukehagar/plexjs/funcs/plexGetGeoData.js"; // Use `PlexAPICore` for best tree-shaking performance. // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -277,11 +277,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -306,11 +306,11 @@ import { plexGetHomeData } from "@lukehagar/plexjs/funcs/plexGetHomeData.js"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -361,15 +361,15 @@ import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/m const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { - const result = await plexAPI.plex.getServerResources(IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "gcgzw5rz2xovp84b4vha3a40"); + const result = await plexAPI.plex.getServerResources(IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "3381b62b-9ab7-4e37-827b-203e9809eb58"); // Handle the result console.log(result); @@ -391,15 +391,15 @@ import { IncludeHttps, IncludeIPv6, IncludeRelay } from "@lukehagar/plexjs/sdk/m // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { - const res = await plexGetServerResources(plexAPI, IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "gcgzw5rz2xovp84b4vha3a40"); + const res = await plexGetServerResources(plexAPI, IncludeHttps.Enable, IncludeRelay.Enable, IncludeIPv6.Enable, "3381b62b-9ab7-4e37-827b-203e9809eb58"); if (!res.ok) { throw res.error; @@ -421,7 +421,7 @@ run(); | `includeHttps` | [operations.IncludeHttps](../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | [object Object] | | `includeRelay` | [operations.IncludeRelay](../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| [object Object] | | `includeIPv6` | [operations.IncludeIPv6](../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | [object Object] | -| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | [object Object] | +| `clientID` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | [object Object] | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | @@ -449,11 +449,11 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -477,11 +477,11 @@ import { plexGetPin } from "@lukehagar/plexjs/funcs/plexGetPin.js"; // Use `PlexAPICore` for best tree-shaking performance. // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -531,11 +531,11 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -561,11 +561,11 @@ import { plexGetTokenByPinId } from "@lukehagar/plexjs/funcs/plexGetTokenByPinId // Use `PlexAPICore` for best tree-shaking performance. // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index 5d4a1ab5..000381c6 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -35,11 +35,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -64,11 +64,11 @@ import { searchPerformSearch } from "@lukehagar/plexjs/funcs/searchPerformSearch // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -125,11 +125,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -154,11 +154,11 @@ import { searchPerformVoiceSearch } from "@lukehagar/plexjs/funcs/searchPerformV // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -211,11 +211,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -240,11 +240,11 @@ import { searchGetSearchResults } from "@lukehagar/plexjs/funcs/searchGetSearchR // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/server/README.md b/docs/sdks/server/README.md index bfd7b162..270fd917 100644 --- a/docs/sdks/server/README.md +++ b/docs/sdks/server/README.md @@ -29,11 +29,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -58,11 +58,11 @@ import { serverGetServerCapabilities } from "@lukehagar/plexjs/funcs/serverGetSe // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -112,11 +112,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -141,11 +141,11 @@ import { serverGetServerPreferences } from "@lukehagar/plexjs/funcs/serverGetSer // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -195,11 +195,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -224,11 +224,11 @@ import { serverGetAvailableClients } from "@lukehagar/plexjs/funcs/serverGetAvai // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -278,11 +278,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -307,11 +307,11 @@ import { serverGetDevices } from "@lukehagar/plexjs/funcs/serverGetDevices.js"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -360,11 +360,11 @@ This request is useful to determine if the server is online or offline import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -388,11 +388,11 @@ import { serverGetServerIdentity } from "@lukehagar/plexjs/funcs/serverGetServer // Use `PlexAPICore` for best tree-shaking performance. // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -441,11 +441,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -470,11 +470,11 @@ import { serverGetMyPlexAccount } from "@lukehagar/plexjs/funcs/serverGetMyPlexA // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -526,11 +526,11 @@ import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -564,11 +564,11 @@ import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -627,11 +627,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -656,11 +656,11 @@ import { serverGetMediaProviders } from "@lukehagar/plexjs/funcs/serverGetMediaP // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -683,7 +683,7 @@ run(); | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | [object Object] | +| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | [object Object] | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | @@ -711,11 +711,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -740,11 +740,11 @@ import { serverGetServerList } from "@lukehagar/plexjs/funcs/serverGetServerList // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index 975297b9..443d0b27 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -24,11 +24,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -53,11 +53,11 @@ import { sessionsGetSessions } from "@lukehagar/plexjs/funcs/sessionsGetSessions // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -107,11 +107,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -136,11 +136,11 @@ import { sessionsGetSessionHistory } from "@lukehagar/plexjs/funcs/sessionsGetSe // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -194,11 +194,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -223,11 +223,11 @@ import { sessionsGetTranscodeSessions } from "@lukehagar/plexjs/funcs/sessionsGe // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -277,11 +277,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -306,11 +306,11 @@ import { sessionsStopTranscodeSession } from "@lukehagar/plexjs/funcs/sessionsSt // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/statistics/README.md b/docs/sdks/statistics/README.md index 51ef8dbf..70a036f0 100644 --- a/docs/sdks/statistics/README.md +++ b/docs/sdks/statistics/README.md @@ -23,11 +23,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -52,11 +52,11 @@ import { statisticsGetStatistics } from "@lukehagar/plexjs/funcs/statisticsGetSt // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -107,11 +107,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -136,11 +136,11 @@ import { statisticsGetResourcesStatistics } from "@lukehagar/plexjs/funcs/statis // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -191,11 +191,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -220,11 +220,11 @@ import { statisticsGetBandwidthStatistics } from "@lukehagar/plexjs/funcs/statis // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/updater/README.md b/docs/sdks/updater/README.md index f79169ec..94ef33ae 100644 --- a/docs/sdks/updater/README.md +++ b/docs/sdks/updater/README.md @@ -24,11 +24,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -53,11 +53,11 @@ import { updaterGetUpdateStatus } from "@lukehagar/plexjs/funcs/updaterGetUpdate // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -108,11 +108,11 @@ import { Download } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -138,11 +138,11 @@ import { Download } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -195,11 +195,11 @@ import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -225,11 +225,11 @@ import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/video/README.md b/docs/sdks/video/README.md index bad216ea..401fbfd2 100644 --- a/docs/sdks/video/README.md +++ b/docs/sdks/video/README.md @@ -23,11 +23,11 @@ import { State } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -64,11 +64,11 @@ import { State } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -130,11 +130,11 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -176,11 +176,11 @@ import { videoStartUniversalTranscode } from "@lukehagar/plexjs/funcs/videoStart // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/docs/sdks/watchlist/README.md b/docs/sdks/watchlist/README.md index 6af7c56f..2c1632c7 100644 --- a/docs/sdks/watchlist/README.md +++ b/docs/sdks/watchlist/README.md @@ -22,11 +22,11 @@ import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { @@ -57,11 +57,11 @@ import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; // You can create one instance of it to use across an application. const plexAPI = new PlexAPICore({ accessToken: "", - clientID: "gcgzw5rz2xovp84b4vha3a40", - clientName: "Plex Web", - clientVersion: "4.133.0", - clientPlatform: "Chrome", - deviceName: "Linux", + clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58", + clientName: "Plex for Roku", + clientVersion: "2.4.1", + platform: "Roku", + deviceNickname: "Roku 3", }); async function run() { diff --git a/jsr.json b/jsr.json index a44fc8f5..4632794d 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@lukehagar/plexjs", - "version": "0.24.1", + "version": "0.24.2", "exports": { ".": "./src/index.ts", "./sdk/models/errors": "./src/sdk/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 0bd141c2..a39f16b0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@lukehagar/plexjs", - "version": "0.24.1", + "version": "0.24.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@lukehagar/plexjs", - "version": "0.24.1", + "version": "0.24.2", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index 2f108d1c..78b17142 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@lukehagar/plexjs", - "version": "0.24.1", + "version": "0.24.2", "author": "LukeHagar", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/activitiesCancelServerActivities.ts b/src/funcs/activitiesCancelServerActivities.ts index 567ebc43..a32bd3e4 100644 --- a/src/funcs/activitiesCancelServerActivities.ts +++ b/src/funcs/activitiesCancelServerActivities.ts @@ -101,8 +101,18 @@ export async function activitiesCancelServerActivities( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/activitiesGetServerActivities.ts b/src/funcs/activitiesGetServerActivities.ts index ac12893c..0196c167 100644 --- a/src/funcs/activitiesGetServerActivities.ts +++ b/src/funcs/activitiesGetServerActivities.ts @@ -74,8 +74,18 @@ export async function activitiesGetServerActivities( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/authenticationGetSourceConnectionInformation.ts b/src/funcs/authenticationGetSourceConnectionInformation.ts index 5ae86236..2a866854 100644 --- a/src/funcs/authenticationGetSourceConnectionInformation.ts +++ b/src/funcs/authenticationGetSourceConnectionInformation.ts @@ -102,8 +102,18 @@ export async function authenticationGetSourceConnectionInformation( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/authenticationGetTokenDetails.ts b/src/funcs/authenticationGetTokenDetails.ts index 03e562cc..e16ab6b0 100644 --- a/src/funcs/authenticationGetTokenDetails.ts +++ b/src/funcs/authenticationGetTokenDetails.ts @@ -79,8 +79,18 @@ export async function authenticationGetTokenDetails( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/authenticationGetTransientToken.ts b/src/funcs/authenticationGetTransientToken.ts index bd04e110..3d03818d 100644 --- a/src/funcs/authenticationGetTransientToken.ts +++ b/src/funcs/authenticationGetTransientToken.ts @@ -101,8 +101,18 @@ export async function authenticationGetTransientToken( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/authenticationPostUsersSignInData.ts b/src/funcs/authenticationPostUsersSignInData.ts index f57d9efc..3376e906 100644 --- a/src/funcs/authenticationPostUsersSignInData.ts +++ b/src/funcs/authenticationPostUsersSignInData.ts @@ -3,7 +3,7 @@ */ import { PlexAPICore } from "../core.js"; -import { encodeBodyForm, encodeFormQuery } from "../lib/encodings.js"; +import { encodeBodyForm, encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; @@ -70,22 +70,55 @@ export async function authenticationPostUsersSignInData( const path = pathToFunc("/users/signin")(); - const query = encodeFormQuery({ - "X-Plex-Client-Identifier": client._options.clientID, - "X-Plex-Client-Identifier": payload.ClientID, - "X-Plex-Device": payload.DeviceName, - "X-Plex-Device": client._options.deviceName, - "X-Plex-Platform": client._options.clientPlatform, - "X-Plex-Platform": payload.ClientPlatform, - "X-Plex-Product": client._options.clientName, - "X-Plex-Product": payload.ClientName, - "X-Plex-Version": payload.ClientVersion, - "X-Plex-Version": client._options.clientVersion, - }); - const headers = new Headers({ "Content-Type": "application/x-www-form-urlencoded", Accept: "application/json", + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + payload.ClientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple("X-Plex-Product", payload.ClientName, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Version": encodeSimple("X-Plex-Version", payload.ClientVersion, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Device": encodeSimple("X-Plex-Device", payload.DeviceNickname, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Platform": encodeSimple("X-Plex-Platform", payload.Platform, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + client._options.clientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Device": encodeSimple( + "X-Plex-Device", + client._options.deviceNickname, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Platform": encodeSimple( + "X-Plex-Platform", + client._options.platform, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple( + "X-Plex-Product", + client._options.clientName, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Version": encodeSimple( + "X-Plex-Version", + client._options.clientVersion, + { explode: false, charEncoding: "none" }, + ), }); const context = { @@ -99,7 +132,6 @@ export async function authenticationPostUsersSignInData( baseURL: baseURL, path: path, headers: headers, - query: query, body: body, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); @@ -112,8 +144,18 @@ export async function authenticationPostUsersSignInData( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/butlerGetButlerTasks.ts b/src/funcs/butlerGetButlerTasks.ts index d73604a5..71b1706b 100644 --- a/src/funcs/butlerGetButlerTasks.ts +++ b/src/funcs/butlerGetButlerTasks.ts @@ -74,8 +74,18 @@ export async function butlerGetButlerTasks( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/butlerStartAllTasks.ts b/src/funcs/butlerStartAllTasks.ts index aaff2818..7e2eb05d 100644 --- a/src/funcs/butlerStartAllTasks.ts +++ b/src/funcs/butlerStartAllTasks.ts @@ -78,8 +78,18 @@ export async function butlerStartAllTasks( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/butlerStartTask.ts b/src/funcs/butlerStartTask.ts index 2c4bea72..c8622fc5 100644 --- a/src/funcs/butlerStartTask.ts +++ b/src/funcs/butlerStartTask.ts @@ -104,8 +104,18 @@ export async function butlerStartTask( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/butlerStopAllTasks.ts b/src/funcs/butlerStopAllTasks.ts index d0395835..b21081ad 100644 --- a/src/funcs/butlerStopAllTasks.ts +++ b/src/funcs/butlerStopAllTasks.ts @@ -74,8 +74,18 @@ export async function butlerStopAllTasks( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/butlerStopTask.ts b/src/funcs/butlerStopTask.ts index 2613c496..8b9fbd22 100644 --- a/src/funcs/butlerStopTask.ts +++ b/src/funcs/butlerStopTask.ts @@ -100,8 +100,18 @@ export async function butlerStopTask( context, errorCodes: ["400", "401", "404", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/hubsGetGlobalHubs.ts b/src/funcs/hubsGetGlobalHubs.ts index e5ed6ad8..3ed3a688 100644 --- a/src/funcs/hubsGetGlobalHubs.ts +++ b/src/funcs/hubsGetGlobalHubs.ts @@ -101,8 +101,18 @@ export async function hubsGetGlobalHubs( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/hubsGetLibraryHubs.ts b/src/funcs/hubsGetLibraryHubs.ts index 678b717e..9f15af9f 100644 --- a/src/funcs/hubsGetLibraryHubs.ts +++ b/src/funcs/hubsGetLibraryHubs.ts @@ -110,8 +110,18 @@ export async function hubsGetLibraryHubs( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/hubsGetRecentlyAdded.ts b/src/funcs/hubsGetRecentlyAdded.ts index 1ef78e7b..c4249ce9 100644 --- a/src/funcs/hubsGetRecentlyAdded.ts +++ b/src/funcs/hubsGetRecentlyAdded.ts @@ -99,8 +99,18 @@ export async function hubsGetRecentlyAdded( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryDeleteLibrary.ts b/src/funcs/libraryDeleteLibrary.ts index 2306e1d7..6734d80f 100644 --- a/src/funcs/libraryDeleteLibrary.ts +++ b/src/funcs/libraryDeleteLibrary.ts @@ -100,8 +100,18 @@ export async function libraryDeleteLibrary( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetAllLibraries.ts b/src/funcs/libraryGetAllLibraries.ts index c5b327fe..9af563c9 100644 --- a/src/funcs/libraryGetAllLibraries.ts +++ b/src/funcs/libraryGetAllLibraries.ts @@ -79,8 +79,18 @@ export async function libraryGetAllLibraries( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetFileHash.ts b/src/funcs/libraryGetFileHash.ts index de8e59f7..79a91106 100644 --- a/src/funcs/libraryGetFileHash.ts +++ b/src/funcs/libraryGetFileHash.ts @@ -101,8 +101,18 @@ export async function libraryGetFileHash( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetLibraryDetails.ts b/src/funcs/libraryGetLibraryDetails.ts index 1ba68b4c..fbeb37ab 100644 --- a/src/funcs/libraryGetLibraryDetails.ts +++ b/src/funcs/libraryGetLibraryDetails.ts @@ -86,8 +86,8 @@ export async function libraryGetLibraryDetails( > > { const input: operations.GetLibraryDetailsRequest = { - sectionKey: sectionKey, includeDetails: includeDetails, + sectionKey: sectionKey, }; const parsed = safeParse( @@ -145,8 +145,18 @@ export async function libraryGetLibraryDetails( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetLibraryItems.ts b/src/funcs/libraryGetLibraryItems.ts index 4952a0ed..8462721d 100644 --- a/src/funcs/libraryGetLibraryItems.ts +++ b/src/funcs/libraryGetLibraryItems.ts @@ -130,8 +130,18 @@ export async function libraryGetLibraryItems( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetMetaDataByRatingKey.ts b/src/funcs/libraryGetMetaDataByRatingKey.ts index 7917963e..a7b6748e 100644 --- a/src/funcs/libraryGetMetaDataByRatingKey.ts +++ b/src/funcs/libraryGetMetaDataByRatingKey.ts @@ -101,8 +101,18 @@ export async function libraryGetMetaDataByRatingKey( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetMetadataChildren.ts b/src/funcs/libraryGetMetadataChildren.ts index 11d14bbb..82c606a9 100644 --- a/src/funcs/libraryGetMetadataChildren.ts +++ b/src/funcs/libraryGetMetadataChildren.ts @@ -108,8 +108,18 @@ export async function libraryGetMetadataChildren( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetOnDeck.ts b/src/funcs/libraryGetOnDeck.ts index 9b6b9665..32c83e08 100644 --- a/src/funcs/libraryGetOnDeck.ts +++ b/src/funcs/libraryGetOnDeck.ts @@ -74,8 +74,18 @@ export async function libraryGetOnDeck( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetRecentlyAddedLibrary.ts b/src/funcs/libraryGetRecentlyAddedLibrary.ts index 75b036d0..484ef72c 100644 --- a/src/funcs/libraryGetRecentlyAddedLibrary.ts +++ b/src/funcs/libraryGetRecentlyAddedLibrary.ts @@ -103,8 +103,18 @@ export async function libraryGetRecentlyAddedLibrary( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetRefreshLibraryMetadata.ts b/src/funcs/libraryGetRefreshLibraryMetadata.ts index 32e1cabe..6c5f10fb 100644 --- a/src/funcs/libraryGetRefreshLibraryMetadata.ts +++ b/src/funcs/libraryGetRefreshLibraryMetadata.ts @@ -48,8 +48,8 @@ export async function libraryGetRefreshLibraryMetadata( > > { const input: operations.GetRefreshLibraryMetadataRequest = { - sectionKey: sectionKey, force: force, + sectionKey: sectionKey, }; const parsed = safeParse( @@ -108,8 +108,18 @@ export async function libraryGetRefreshLibraryMetadata( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetSearchLibrary.ts b/src/funcs/libraryGetSearchLibrary.ts index e2168cf0..a6db5367 100644 --- a/src/funcs/libraryGetSearchLibrary.ts +++ b/src/funcs/libraryGetSearchLibrary.ts @@ -124,8 +124,18 @@ export async function libraryGetSearchLibrary( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/libraryGetTopWatchedContent.ts b/src/funcs/libraryGetTopWatchedContent.ts index f21cd5d5..df69ed95 100644 --- a/src/funcs/libraryGetTopWatchedContent.ts +++ b/src/funcs/libraryGetTopWatchedContent.ts @@ -48,8 +48,8 @@ export async function libraryGetTopWatchedContent( > > { const input: operations.GetTopWatchedContentRequest = { - type: type, includeGuids: includeGuids, + type: type, }; const parsed = safeParse( @@ -102,8 +102,18 @@ export async function libraryGetTopWatchedContent( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/logEnablePaperTrail.ts b/src/funcs/logEnablePaperTrail.ts index 65dad8ed..62cdeb3f 100644 --- a/src/funcs/logEnablePaperTrail.ts +++ b/src/funcs/logEnablePaperTrail.ts @@ -74,8 +74,18 @@ export async function logEnablePaperTrail( context, errorCodes: ["400", "401", "403", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/logLogLine.ts b/src/funcs/logLogLine.ts index 7c64af4b..408b59aa 100644 --- a/src/funcs/logLogLine.ts +++ b/src/funcs/logLogLine.ts @@ -104,8 +104,18 @@ export async function logLogLine( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/logLogMultiLine.ts b/src/funcs/logLogMultiLine.ts index ef467c3a..492d4fb5 100644 --- a/src/funcs/logLogMultiLine.ts +++ b/src/funcs/logLogMultiLine.ts @@ -112,8 +112,18 @@ export async function logLogMultiLine( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/mediaGetBannerImage.ts b/src/funcs/mediaGetBannerImage.ts index 1239a30a..a1e267f5 100644 --- a/src/funcs/mediaGetBannerImage.ts +++ b/src/funcs/mediaGetBannerImage.ts @@ -73,11 +73,14 @@ export async function mediaGetBannerImage( "minSize": payload.minSize, "upscale": payload.upscale, "width": payload.width, - "X-Plex-Token": payload["X-Plex-Token"], }); const headers = new Headers({ Accept: "image/jpeg", + "X-Plex-Token": encodeSimple("X-Plex-Token", payload["X-Plex-Token"], { + explode: false, + charEncoding: "none", + }), }); const secConfig = await extractSecurity(client._options.accessToken); @@ -107,8 +110,18 @@ export async function mediaGetBannerImage( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/mediaGetThumbImage.ts b/src/funcs/mediaGetThumbImage.ts index 935b5ce0..c9fc31a1 100644 --- a/src/funcs/mediaGetThumbImage.ts +++ b/src/funcs/mediaGetThumbImage.ts @@ -73,11 +73,14 @@ export async function mediaGetThumbImage( "minSize": payload.minSize, "upscale": payload.upscale, "width": payload.width, - "X-Plex-Token": payload["X-Plex-Token"], }); const headers = new Headers({ Accept: "image/jpeg", + "X-Plex-Token": encodeSimple("X-Plex-Token", payload["X-Plex-Token"], { + explode: false, + charEncoding: "none", + }), }); const secConfig = await extractSecurity(client._options.accessToken); @@ -107,8 +110,18 @@ export async function mediaGetThumbImage( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/mediaMarkPlayed.ts b/src/funcs/mediaMarkPlayed.ts index fafb70fe..923e1748 100644 --- a/src/funcs/mediaMarkPlayed.ts +++ b/src/funcs/mediaMarkPlayed.ts @@ -98,8 +98,18 @@ export async function mediaMarkPlayed( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/mediaMarkUnplayed.ts b/src/funcs/mediaMarkUnplayed.ts index 4e707c9e..ee521ce4 100644 --- a/src/funcs/mediaMarkUnplayed.ts +++ b/src/funcs/mediaMarkUnplayed.ts @@ -98,8 +98,18 @@ export async function mediaMarkUnplayed( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/mediaUpdatePlayProgress.ts b/src/funcs/mediaUpdatePlayProgress.ts index efcb4bd5..6b650556 100644 --- a/src/funcs/mediaUpdatePlayProgress.ts +++ b/src/funcs/mediaUpdatePlayProgress.ts @@ -104,8 +104,18 @@ export async function mediaUpdatePlayProgress( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsAddPlaylistContents.ts b/src/funcs/playlistsAddPlaylistContents.ts index c9eaf0fd..4c4984fc 100644 --- a/src/funcs/playlistsAddPlaylistContents.ts +++ b/src/funcs/playlistsAddPlaylistContents.ts @@ -112,8 +112,18 @@ export async function playlistsAddPlaylistContents( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsClearPlaylistContents.ts b/src/funcs/playlistsClearPlaylistContents.ts index e118d70c..37142426 100644 --- a/src/funcs/playlistsClearPlaylistContents.ts +++ b/src/funcs/playlistsClearPlaylistContents.ts @@ -101,8 +101,18 @@ export async function playlistsClearPlaylistContents( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsCreatePlaylist.ts b/src/funcs/playlistsCreatePlaylist.ts index 76a5f396..3ee4c99f 100644 --- a/src/funcs/playlistsCreatePlaylist.ts +++ b/src/funcs/playlistsCreatePlaylist.ts @@ -102,8 +102,18 @@ export async function playlistsCreatePlaylist( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsDeletePlaylist.ts b/src/funcs/playlistsDeletePlaylist.ts index b4f37c28..fd84605f 100644 --- a/src/funcs/playlistsDeletePlaylist.ts +++ b/src/funcs/playlistsDeletePlaylist.ts @@ -100,8 +100,18 @@ export async function playlistsDeletePlaylist( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsGetPlaylist.ts b/src/funcs/playlistsGetPlaylist.ts index ea4ab7f7..9a55e747 100644 --- a/src/funcs/playlistsGetPlaylist.ts +++ b/src/funcs/playlistsGetPlaylist.ts @@ -101,8 +101,18 @@ export async function playlistsGetPlaylist( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsGetPlaylistContents.ts b/src/funcs/playlistsGetPlaylistContents.ts index 55f86d18..7b3cfa95 100644 --- a/src/funcs/playlistsGetPlaylistContents.ts +++ b/src/funcs/playlistsGetPlaylistContents.ts @@ -111,8 +111,18 @@ export async function playlistsGetPlaylistContents( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsGetPlaylists.ts b/src/funcs/playlistsGetPlaylists.ts index 50ccf265..2dea7273 100644 --- a/src/funcs/playlistsGetPlaylists.ts +++ b/src/funcs/playlistsGetPlaylists.ts @@ -101,8 +101,18 @@ export async function playlistsGetPlaylists( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsUpdatePlaylist.ts b/src/funcs/playlistsUpdatePlaylist.ts index 46cf76be..4b1f6857 100644 --- a/src/funcs/playlistsUpdatePlaylist.ts +++ b/src/funcs/playlistsUpdatePlaylist.ts @@ -110,8 +110,18 @@ export async function playlistsUpdatePlaylist( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/playlistsUploadPlaylist.ts b/src/funcs/playlistsUploadPlaylist.ts index 9b4a3672..0766678d 100644 --- a/src/funcs/playlistsUploadPlaylist.ts +++ b/src/funcs/playlistsUploadPlaylist.ts @@ -104,8 +104,18 @@ export async function playlistsUploadPlaylist( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetCompanionsData.ts b/src/funcs/plexGetCompanionsData.ts index 2c742abc..e274a8ee 100644 --- a/src/funcs/plexGetCompanionsData.ts +++ b/src/funcs/plexGetCompanionsData.ts @@ -81,8 +81,18 @@ export async function plexGetCompanionsData( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetGeoData.ts b/src/funcs/plexGetGeoData.ts index 50cdb5b9..86fca99d 100644 --- a/src/funcs/plexGetGeoData.ts +++ b/src/funcs/plexGetGeoData.ts @@ -74,8 +74,18 @@ export async function plexGetGeoData( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetHomeData.ts b/src/funcs/plexGetHomeData.ts index 3a48f058..c16d349f 100644 --- a/src/funcs/plexGetHomeData.ts +++ b/src/funcs/plexGetHomeData.ts @@ -74,8 +74,18 @@ export async function plexGetHomeData( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetPin.ts b/src/funcs/plexGetPin.ts index 28994987..5e9675ee 100644 --- a/src/funcs/plexGetPin.ts +++ b/src/funcs/plexGetPin.ts @@ -3,7 +3,7 @@ */ import { PlexAPICore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; +import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; @@ -65,20 +65,56 @@ export async function plexGetPin( const query = encodeFormQuery({ "strong": payload.strong, - "X-Plex-Client-Identifier": payload.ClientID, - "X-Plex-Client-Identifier": client._options.clientID, - "X-Plex-Device": client._options.deviceName, - "X-Plex-Device": payload.DeviceName, - "X-Plex-Platform": payload.ClientPlatform, - "X-Plex-Platform": client._options.clientPlatform, - "X-Plex-Product": payload.ClientName, - "X-Plex-Product": client._options.clientName, - "X-Plex-Version": payload.ClientVersion, - "X-Plex-Version": client._options.clientVersion, }); const headers = new Headers({ Accept: "application/json", + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + payload.ClientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple("X-Plex-Product", payload.ClientName, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Version": encodeSimple("X-Plex-Version", payload.ClientVersion, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Device": encodeSimple("X-Plex-Device", payload.DeviceNickname, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Platform": encodeSimple("X-Plex-Platform", payload.Platform, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + client._options.clientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Device": encodeSimple( + "X-Plex-Device", + client._options.deviceNickname, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Platform": encodeSimple( + "X-Plex-Platform", + client._options.platform, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple( + "X-Plex-Product", + client._options.clientName, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Version": encodeSimple( + "X-Plex-Version", + client._options.clientVersion, + { explode: false, charEncoding: "none" }, + ), }); const context = { @@ -105,8 +141,18 @@ export async function plexGetPin( context, errorCodes: ["400", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetServerResources.ts b/src/funcs/plexGetServerResources.ts index 79267764..c2456bb8 100644 --- a/src/funcs/plexGetServerResources.ts +++ b/src/funcs/plexGetServerResources.ts @@ -3,7 +3,7 @@ */ import { PlexAPICore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; +import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; @@ -79,12 +79,20 @@ export async function plexGetServerResources( "includeHttps": payload.includeHttps, "includeIPv6": payload.includeIPv6, "includeRelay": payload.includeRelay, - "X-Plex-Client-Identifier": payload.ClientID, - "X-Plex-Client-Identifier": client._options.clientID, }); const headers = new Headers({ Accept: "application/json", + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + payload.ClientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + client._options.clientID, + { explode: false, charEncoding: "none" }, + ), }); const secConfig = await extractSecurity(client._options.accessToken); @@ -115,8 +123,18 @@ export async function plexGetServerResources( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetTokenByPinId.ts b/src/funcs/plexGetTokenByPinId.ts index 17097d9d..01d621f3 100644 --- a/src/funcs/plexGetTokenByPinId.ts +++ b/src/funcs/plexGetTokenByPinId.ts @@ -3,7 +3,7 @@ */ import { PlexAPICore } from "../core.js"; -import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; +import { encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; @@ -71,21 +71,54 @@ export async function plexGetTokenByPinId( const path = pathToFunc("/pins/{pinID}")(pathParams); - const query = encodeFormQuery({ - "X-Plex-Client-Identifier": client._options.clientID, - "X-Plex-Client-Identifier": payload.ClientID, - "X-Plex-Device": client._options.deviceName, - "X-Plex-Device": payload.DeviceName, - "X-Plex-Platform": payload.ClientPlatform, - "X-Plex-Platform": client._options.clientPlatform, - "X-Plex-Product": client._options.clientName, - "X-Plex-Product": payload.ClientName, - "X-Plex-Version": payload.ClientVersion, - "X-Plex-Version": client._options.clientVersion, - }); - const headers = new Headers({ Accept: "application/json", + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + payload.ClientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple("X-Plex-Product", payload.ClientName, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Version": encodeSimple("X-Plex-Version", payload.ClientVersion, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Device": encodeSimple("X-Plex-Device", payload.DeviceNickname, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Platform": encodeSimple("X-Plex-Platform", payload.Platform, { + explode: false, + charEncoding: "none", + }), + "X-Plex-Client-Identifier": encodeSimple( + "X-Plex-Client-Identifier", + client._options.clientID, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Device": encodeSimple( + "X-Plex-Device", + client._options.deviceNickname, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Platform": encodeSimple( + "X-Plex-Platform", + client._options.platform, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Product": encodeSimple( + "X-Plex-Product", + client._options.clientName, + { explode: false, charEncoding: "none" }, + ), + "X-Plex-Version": encodeSimple( + "X-Plex-Version", + client._options.clientVersion, + { explode: false, charEncoding: "none" }, + ), }); const context = { @@ -99,7 +132,6 @@ export async function plexGetTokenByPinId( baseURL: baseURL, path: path, headers: headers, - query: query, body: body, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); @@ -112,8 +144,18 @@ export async function plexGetTokenByPinId( context, errorCodes: ["400", "404", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/plexGetUserFriends.ts b/src/funcs/plexGetUserFriends.ts index 5bd0de90..9e51b6df 100644 --- a/src/funcs/plexGetUserFriends.ts +++ b/src/funcs/plexGetUserFriends.ts @@ -79,8 +79,18 @@ export async function plexGetUserFriends( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/searchGetSearchResults.ts b/src/funcs/searchGetSearchResults.ts index 31322401..c9fe1d30 100644 --- a/src/funcs/searchGetSearchResults.ts +++ b/src/funcs/searchGetSearchResults.ts @@ -98,8 +98,18 @@ export async function searchGetSearchResults( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/searchPerformSearch.ts b/src/funcs/searchPerformSearch.ts index 056ded1b..f018a1f4 100644 --- a/src/funcs/searchPerformSearch.ts +++ b/src/funcs/searchPerformSearch.ts @@ -115,8 +115,18 @@ export async function searchPerformSearch( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/searchPerformVoiceSearch.ts b/src/funcs/searchPerformVoiceSearch.ts index 560cc066..869ecbe0 100644 --- a/src/funcs/searchPerformVoiceSearch.ts +++ b/src/funcs/searchPerformVoiceSearch.ts @@ -107,8 +107,18 @@ export async function searchPerformVoiceSearch( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetAvailableClients.ts b/src/funcs/serverGetAvailableClients.ts index e443eaf2..474420c0 100644 --- a/src/funcs/serverGetAvailableClients.ts +++ b/src/funcs/serverGetAvailableClients.ts @@ -74,8 +74,18 @@ export async function serverGetAvailableClients( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetDevices.ts b/src/funcs/serverGetDevices.ts index b5822b0f..b6e6a7e6 100644 --- a/src/funcs/serverGetDevices.ts +++ b/src/funcs/serverGetDevices.ts @@ -74,8 +74,18 @@ export async function serverGetDevices( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetMediaProviders.ts b/src/funcs/serverGetMediaProviders.ts index d31091be..db61f4a1 100644 --- a/src/funcs/serverGetMediaProviders.ts +++ b/src/funcs/serverGetMediaProviders.ts @@ -3,7 +3,7 @@ */ import { PlexAPICore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; +import { encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; @@ -63,12 +63,12 @@ export async function serverGetMediaProviders( const path = pathToFunc("/media/providers")(); - const query = encodeFormQuery({ - "X-Plex-Token": payload["X-Plex-Token"], - }); - const headers = new Headers({ Accept: "application/json", + "X-Plex-Token": encodeSimple("X-Plex-Token", payload["X-Plex-Token"], { + explode: false, + charEncoding: "none", + }), }); const secConfig = await extractSecurity(client._options.accessToken); @@ -85,7 +85,6 @@ export async function serverGetMediaProviders( method: "GET", path: path, headers: headers, - query: query, body: body, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); @@ -98,8 +97,18 @@ export async function serverGetMediaProviders( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetMyPlexAccount.ts b/src/funcs/serverGetMyPlexAccount.ts index 4c437869..f881fc22 100644 --- a/src/funcs/serverGetMyPlexAccount.ts +++ b/src/funcs/serverGetMyPlexAccount.ts @@ -74,8 +74,18 @@ export async function serverGetMyPlexAccount( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetResizedPhoto.ts b/src/funcs/serverGetResizedPhoto.ts index b81c8a65..89fc3ff0 100644 --- a/src/funcs/serverGetResizedPhoto.ts +++ b/src/funcs/serverGetResizedPhoto.ts @@ -102,8 +102,18 @@ export async function serverGetResizedPhoto( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetServerCapabilities.ts b/src/funcs/serverGetServerCapabilities.ts index 753c572d..58dbbea9 100644 --- a/src/funcs/serverGetServerCapabilities.ts +++ b/src/funcs/serverGetServerCapabilities.ts @@ -74,8 +74,18 @@ export async function serverGetServerCapabilities( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetServerIdentity.ts b/src/funcs/serverGetServerIdentity.ts index 9da0e0e5..839986f0 100644 --- a/src/funcs/serverGetServerIdentity.ts +++ b/src/funcs/serverGetServerIdentity.ts @@ -68,8 +68,18 @@ export async function serverGetServerIdentity( context, errorCodes: ["408", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetServerList.ts b/src/funcs/serverGetServerList.ts index 806cb23e..977b29ca 100644 --- a/src/funcs/serverGetServerList.ts +++ b/src/funcs/serverGetServerList.ts @@ -74,8 +74,18 @@ export async function serverGetServerList( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/serverGetServerPreferences.ts b/src/funcs/serverGetServerPreferences.ts index 8e1dfc32..68822734 100644 --- a/src/funcs/serverGetServerPreferences.ts +++ b/src/funcs/serverGetServerPreferences.ts @@ -74,8 +74,18 @@ export async function serverGetServerPreferences( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/sessionsGetSessionHistory.ts b/src/funcs/sessionsGetSessionHistory.ts index 849499df..02248d02 100644 --- a/src/funcs/sessionsGetSessionHistory.ts +++ b/src/funcs/sessionsGetSessionHistory.ts @@ -107,8 +107,18 @@ export async function sessionsGetSessionHistory( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/sessionsGetSessions.ts b/src/funcs/sessionsGetSessions.ts index f61c4f81..48e6a089 100644 --- a/src/funcs/sessionsGetSessions.ts +++ b/src/funcs/sessionsGetSessions.ts @@ -74,8 +74,18 @@ export async function sessionsGetSessions( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/sessionsGetTranscodeSessions.ts b/src/funcs/sessionsGetTranscodeSessions.ts index 61622569..28e5aa58 100644 --- a/src/funcs/sessionsGetTranscodeSessions.ts +++ b/src/funcs/sessionsGetTranscodeSessions.ts @@ -74,8 +74,18 @@ export async function sessionsGetTranscodeSessions( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/sessionsStopTranscodeSession.ts b/src/funcs/sessionsStopTranscodeSession.ts index 8dfb9bd4..ce263fb3 100644 --- a/src/funcs/sessionsStopTranscodeSession.ts +++ b/src/funcs/sessionsStopTranscodeSession.ts @@ -101,8 +101,18 @@ export async function sessionsStopTranscodeSession( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/statisticsGetBandwidthStatistics.ts b/src/funcs/statisticsGetBandwidthStatistics.ts index a368e002..2576477b 100644 --- a/src/funcs/statisticsGetBandwidthStatistics.ts +++ b/src/funcs/statisticsGetBandwidthStatistics.ts @@ -99,8 +99,18 @@ export async function statisticsGetBandwidthStatistics( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/statisticsGetResourcesStatistics.ts b/src/funcs/statisticsGetResourcesStatistics.ts index 60eab53c..7bb9d6f6 100644 --- a/src/funcs/statisticsGetResourcesStatistics.ts +++ b/src/funcs/statisticsGetResourcesStatistics.ts @@ -99,8 +99,18 @@ export async function statisticsGetResourcesStatistics( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/statisticsGetStatistics.ts b/src/funcs/statisticsGetStatistics.ts index d87de25f..78838b22 100644 --- a/src/funcs/statisticsGetStatistics.ts +++ b/src/funcs/statisticsGetStatistics.ts @@ -98,8 +98,18 @@ export async function statisticsGetStatistics( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/updaterApplyUpdates.ts b/src/funcs/updaterApplyUpdates.ts index 4de1c189..0dc4ef18 100644 --- a/src/funcs/updaterApplyUpdates.ts +++ b/src/funcs/updaterApplyUpdates.ts @@ -101,8 +101,18 @@ export async function updaterApplyUpdates( context, errorCodes: ["400", "401", "4XX", "500", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/updaterCheckForUpdates.ts b/src/funcs/updaterCheckForUpdates.ts index ee3aa0ec..7aa36ed5 100644 --- a/src/funcs/updaterCheckForUpdates.ts +++ b/src/funcs/updaterCheckForUpdates.ts @@ -98,8 +98,18 @@ export async function updaterCheckForUpdates( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/updaterGetUpdateStatus.ts b/src/funcs/updaterGetUpdateStatus.ts index 59aab923..5ed56203 100644 --- a/src/funcs/updaterGetUpdateStatus.ts +++ b/src/funcs/updaterGetUpdateStatus.ts @@ -74,8 +74,18 @@ export async function updaterGetUpdateStatus( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/videoGetTimeline.ts b/src/funcs/videoGetTimeline.ts index 5ba0795d..f6b9e076 100644 --- a/src/funcs/videoGetTimeline.ts +++ b/src/funcs/videoGetTimeline.ts @@ -105,8 +105,18 @@ export async function videoGetTimeline( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/videoStartUniversalTranscode.ts b/src/funcs/videoStartUniversalTranscode.ts index 16750cd7..adcbae79 100644 --- a/src/funcs/videoStartUniversalTranscode.ts +++ b/src/funcs/videoStartUniversalTranscode.ts @@ -112,8 +112,18 @@ export async function videoStartUniversalTranscode( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/funcs/watchlistGetWatchList.ts b/src/funcs/watchlistGetWatchList.ts index 0e000b7f..030445e3 100644 --- a/src/funcs/watchlistGetWatchList.ts +++ b/src/funcs/watchlistGetWatchList.ts @@ -80,11 +80,14 @@ export async function watchlistGetWatchList( "sort": payload.sort, "X-Plex-Container-Size": payload["X-Plex-Container-Size"], "X-Plex-Container-Start": payload["X-Plex-Container-Start"], - "X-Plex-Token": payload["X-Plex-Token"], }); const headers = new Headers({ Accept: "application/json", + "X-Plex-Token": encodeSimple("X-Plex-Token", payload["X-Plex-Token"], { + explode: false, + charEncoding: "none", + }), }); const secConfig = await extractSecurity(client._options.accessToken); @@ -115,8 +118,18 @@ export async function watchlistGetWatchList( context, errorCodes: ["400", "401", "4XX", "5XX"], retryConfig: options?.retries - || client._options.retryConfig, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + }, + retryCodes: options?.retryCodes || ["5XX"], }); if (!doResult.ok) { return doResult; diff --git a/src/lib/config.ts b/src/lib/config.ts index 3fe7b7c2..8683585a 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -49,14 +49,14 @@ export type SDKOptions = { clientVersion?: string | undefined; /** - * Allows setting the clientPlatform parameter for all supported operations + * Allows setting the platform parameter for all supported operations */ - clientPlatform?: string | undefined; + platform?: string | undefined; /** - * Allows setting the deviceName parameter for all supported operations + * Allows setting the deviceNickname parameter for all supported operations */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; httpClient?: HTTPClient; /** @@ -115,7 +115,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.3", - sdkVersion: "0.24.1", + sdkVersion: "0.24.2", genVersion: "2.428.1", - userAgent: "speakeasy-sdk/typescript 0.24.1 2.428.1 0.0.3 @lukehagar/plexjs", + userAgent: "speakeasy-sdk/typescript 0.24.2 2.428.1 0.0.3 @lukehagar/plexjs", } as const; diff --git a/src/sdk/models/operations/getbannerimage.ts b/src/sdk/models/operations/getbannerimage.ts index 8a15c7e2..909484df 100644 --- a/src/sdk/models/operations/getbannerimage.ts +++ b/src/sdk/models/operations/getbannerimage.ts @@ -15,7 +15,7 @@ export type GetBannerImageRequest = { minSize: number; upscale: number; /** - * Plex Authentication Token + * An authentication token, obtained from plex.tv */ xPlexToken: string; }; diff --git a/src/sdk/models/operations/getlibrarydetails.ts b/src/sdk/models/operations/getlibrarydetails.ts index 1c7b03ef..f54f0ffa 100644 --- a/src/sdk/models/operations/getlibrarydetails.ts +++ b/src/sdk/models/operations/getlibrarydetails.ts @@ -17,13 +17,6 @@ export enum IncludeDetails { } export type GetLibraryDetailsRequest = { - /** - * The unique key of the Plex library. - * - * @remarks - * Note: This is unique in the context of the Plex server. - */ - sectionKey: number; /** * Whether or not to include details for a section (types, filters, and sorts). * @@ -31,6 +24,13 @@ export type GetLibraryDetailsRequest = { * Only exists for backwards compatibility, media providers other than the server libraries have it on always. */ includeDetails?: IncludeDetails | undefined; + /** + * The unique key of the Plex library. + * + * @remarks + * Note: This is unique in the context of the Plex server. + */ + sectionKey: number; }; export type GetLibraryDetailsDirectory = { @@ -156,14 +156,14 @@ export const GetLibraryDetailsRequest$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - sectionKey: z.number().int(), includeDetails: IncludeDetails$inboundSchema, + sectionKey: z.number().int(), }); /** @internal */ export type GetLibraryDetailsRequest$Outbound = { - sectionKey: number; includeDetails: number; + sectionKey: number; }; /** @internal */ @@ -172,8 +172,8 @@ export const GetLibraryDetailsRequest$outboundSchema: z.ZodType< z.ZodTypeDef, GetLibraryDetailsRequest > = z.object({ - sectionKey: z.number().int(), includeDetails: IncludeDetails$outboundSchema.default(IncludeDetails.Zero), + sectionKey: z.number().int(), }); /** diff --git a/src/sdk/models/operations/getlibraryitems.ts b/src/sdk/models/operations/getlibraryitems.ts index 9e604380..b88a7a0f 100644 --- a/src/sdk/models/operations/getlibraryitems.ts +++ b/src/sdk/models/operations/getlibraryitems.ts @@ -69,13 +69,6 @@ export enum GetLibraryItemsQueryParamIncludeMeta { } export type GetLibraryItemsRequest = { - /** - * The unique key of the Plex library. - * - * @remarks - * Note: This is unique in the context of the Plex server. - */ - sectionKey: number; /** * A key representing a specific tag within the section. */ @@ -97,6 +90,13 @@ export type GetLibraryItemsRequest = { * E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries */ type?: GetLibraryItemsQueryParamType | undefined; + /** + * The unique key of the Plex library. + * + * @remarks + * Note: This is unique in the context of the Plex server. + */ + sectionKey: number; /** * Adds the Meta object to the response * @@ -873,10 +873,10 @@ export const GetLibraryItemsRequest$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - sectionKey: z.number().int(), tag: Tag$inboundSchema, includeGuids: IncludeGuids$inboundSchema, type: GetLibraryItemsQueryParamType$inboundSchema.optional(), + sectionKey: z.number().int(), includeMeta: GetLibraryItemsQueryParamIncludeMeta$inboundSchema, "X-Plex-Container-Start": z.number().int().default(0), "X-Plex-Container-Size": z.number().int().default(50), @@ -889,10 +889,10 @@ export const GetLibraryItemsRequest$inboundSchema: z.ZodType< /** @internal */ export type GetLibraryItemsRequest$Outbound = { - sectionKey: number; tag: string; includeGuids: number; type?: number | undefined; + sectionKey: number; includeMeta: number; "X-Plex-Container-Start": number; "X-Plex-Container-Size": number; @@ -904,10 +904,10 @@ export const GetLibraryItemsRequest$outboundSchema: z.ZodType< z.ZodTypeDef, GetLibraryItemsRequest > = z.object({ - sectionKey: z.number().int(), tag: Tag$outboundSchema, includeGuids: IncludeGuids$outboundSchema.default(IncludeGuids.Disable), type: GetLibraryItemsQueryParamType$outboundSchema.optional(), + sectionKey: z.number().int(), includeMeta: GetLibraryItemsQueryParamIncludeMeta$outboundSchema.default( GetLibraryItemsQueryParamIncludeMeta.Disable, ), diff --git a/src/sdk/models/operations/getmediaproviders.ts b/src/sdk/models/operations/getmediaproviders.ts index 6e195760..ad3538a8 100644 --- a/src/sdk/models/operations/getmediaproviders.ts +++ b/src/sdk/models/operations/getmediaproviders.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../../lib/primitives.js"; export type GetMediaProvidersRequest = { /** - * Plex Authentication Token + * An authentication token, obtained from plex.tv */ xPlexToken: string; }; diff --git a/src/sdk/models/operations/getpin.ts b/src/sdk/models/operations/getpin.ts index 4f90a447..ad5aa14a 100644 --- a/src/sdk/models/operations/getpin.ts +++ b/src/sdk/models/operations/getpin.ts @@ -11,25 +11,25 @@ export const GetPinServerList = [ export type GetPinGlobals = { /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; }; export type GetPinRequest = { @@ -42,25 +42,25 @@ export type GetPinRequest = { */ strong?: boolean | undefined; /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; }; /** @@ -167,16 +167,16 @@ export const GetPinGlobals$inboundSchema: z.ZodType< > = z.object({ ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", }); }); @@ -184,9 +184,9 @@ export const GetPinGlobals$inboundSchema: z.ZodType< export type GetPinGlobals$Outbound = { ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; }; /** @internal */ @@ -197,16 +197,16 @@ export const GetPinGlobals$outboundSchema: z.ZodType< > = z.object({ clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", }); }); @@ -232,16 +232,16 @@ export const GetPinRequest$inboundSchema: z.ZodType< strong: z.boolean().default(false), ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", }); }); @@ -250,9 +250,9 @@ export type GetPinRequest$Outbound = { strong: boolean; ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; }; /** @internal */ @@ -264,16 +264,16 @@ export const GetPinRequest$outboundSchema: z.ZodType< strong: z.boolean().default(false), clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", }); }); diff --git a/src/sdk/models/operations/getrefreshlibrarymetadata.ts b/src/sdk/models/operations/getrefreshlibrarymetadata.ts index 90eeb8d5..3c1a289a 100644 --- a/src/sdk/models/operations/getrefreshlibrarymetadata.ts +++ b/src/sdk/models/operations/getrefreshlibrarymetadata.ts @@ -14,6 +14,10 @@ export enum Force { } export type GetRefreshLibraryMetadataRequest = { + /** + * Force the refresh even if the library is already being refreshed. + */ + force?: Force | undefined; /** * The unique key of the Plex library. * @@ -21,10 +25,6 @@ export type GetRefreshLibraryMetadataRequest = { * Note: This is unique in the context of the Plex server. */ sectionKey: number; - /** - * Force the refresh even if the library is already being refreshed. - */ - force?: Force | undefined; }; export type GetRefreshLibraryMetadataResponse = { @@ -68,14 +68,14 @@ export const GetRefreshLibraryMetadataRequest$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - sectionKey: z.number().int(), force: Force$inboundSchema.optional(), + sectionKey: z.number().int(), }); /** @internal */ export type GetRefreshLibraryMetadataRequest$Outbound = { - sectionKey: number; force?: number | undefined; + sectionKey: number; }; /** @internal */ @@ -84,8 +84,8 @@ export const GetRefreshLibraryMetadataRequest$outboundSchema: z.ZodType< z.ZodTypeDef, GetRefreshLibraryMetadataRequest > = z.object({ - sectionKey: z.number().int(), force: Force$outboundSchema.optional(), + sectionKey: z.number().int(), }); /** diff --git a/src/sdk/models/operations/getserverresources.ts b/src/sdk/models/operations/getserverresources.ts index 080bdb85..7677f321 100644 --- a/src/sdk/models/operations/getserverresources.ts +++ b/src/sdk/models/operations/getserverresources.ts @@ -11,7 +11,7 @@ export const GetServerResourcesServerList = [ export type GetServerResourcesGlobals = { /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; }; @@ -60,7 +60,7 @@ export type GetServerResourcesRequest = { */ includeIPv6?: IncludeIPv6 | undefined; /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; }; diff --git a/src/sdk/models/operations/getthumbimage.ts b/src/sdk/models/operations/getthumbimage.ts index 412a6c74..3a806e11 100644 --- a/src/sdk/models/operations/getthumbimage.ts +++ b/src/sdk/models/operations/getthumbimage.ts @@ -15,7 +15,7 @@ export type GetThumbImageRequest = { minSize: number; upscale: number; /** - * Plex Authentication Token + * An authentication token, obtained from plex.tv */ xPlexToken: string; }; diff --git a/src/sdk/models/operations/gettokenbypinid.ts b/src/sdk/models/operations/gettokenbypinid.ts index 24fa4da4..24ebf1c8 100644 --- a/src/sdk/models/operations/gettokenbypinid.ts +++ b/src/sdk/models/operations/gettokenbypinid.ts @@ -11,25 +11,25 @@ export const GetTokenByPinIdServerList = [ export type GetTokenByPinIdGlobals = { /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; }; export type GetTokenByPinIdRequest = { @@ -38,25 +38,25 @@ export type GetTokenByPinIdRequest = { */ pinID: number; /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; }; /** @@ -163,16 +163,16 @@ export const GetTokenByPinIdGlobals$inboundSchema: z.ZodType< > = z.object({ ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", }); }); @@ -180,9 +180,9 @@ export const GetTokenByPinIdGlobals$inboundSchema: z.ZodType< export type GetTokenByPinIdGlobals$Outbound = { ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; }; /** @internal */ @@ -193,16 +193,16 @@ export const GetTokenByPinIdGlobals$outboundSchema: z.ZodType< > = z.object({ clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", }); }); @@ -228,16 +228,16 @@ export const GetTokenByPinIdRequest$inboundSchema: z.ZodType< pinID: z.number().int(), ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", }); }); @@ -246,9 +246,9 @@ export type GetTokenByPinIdRequest$Outbound = { pinID: number; ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; }; /** @internal */ @@ -260,16 +260,16 @@ export const GetTokenByPinIdRequest$outboundSchema: z.ZodType< pinID: z.number().int(), clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", }); }); diff --git a/src/sdk/models/operations/gettopwatchedcontent.ts b/src/sdk/models/operations/gettopwatchedcontent.ts index eacc6d73..389e74f3 100644 --- a/src/sdk/models/operations/gettopwatchedcontent.ts +++ b/src/sdk/models/operations/gettopwatchedcontent.ts @@ -24,6 +24,12 @@ export enum GetTopWatchedContentQueryParamType { } export type GetTopWatchedContentRequest = { + /** + * Adds the Guids object to the response + * + * @remarks + */ + includeGuids?: number | undefined; /** * The type of media to retrieve. * @@ -35,12 +41,6 @@ export type GetTopWatchedContentRequest = { * E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries */ type: GetTopWatchedContentQueryParamType; - /** - * Adds the Guids object to the response - * - * @remarks - */ - includeGuids?: number | undefined; }; export type GetTopWatchedContentGenre = { @@ -170,14 +170,14 @@ export const GetTopWatchedContentRequest$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - type: GetTopWatchedContentQueryParamType$inboundSchema, includeGuids: z.number().int().optional(), + type: GetTopWatchedContentQueryParamType$inboundSchema, }); /** @internal */ export type GetTopWatchedContentRequest$Outbound = { - type: number; includeGuids?: number | undefined; + type: number; }; /** @internal */ @@ -186,8 +186,8 @@ export const GetTopWatchedContentRequest$outboundSchema: z.ZodType< z.ZodTypeDef, GetTopWatchedContentRequest > = z.object({ - type: GetTopWatchedContentQueryParamType$outboundSchema, includeGuids: z.number().int().optional(), + type: GetTopWatchedContentQueryParamType$outboundSchema, }); /** diff --git a/src/sdk/models/operations/getwatchlist.ts b/src/sdk/models/operations/getwatchlist.ts index 8fa3c2d9..0eaffa4a 100644 --- a/src/sdk/models/operations/getwatchlist.ts +++ b/src/sdk/models/operations/getwatchlist.ts @@ -107,7 +107,7 @@ export type GetWatchListRequest = { */ xPlexContainerSize?: number | undefined; /** - * Plex Authentication Token + * An authentication token, obtained from plex.tv */ xPlexToken: string; }; diff --git a/src/sdk/models/operations/postuserssignindata.ts b/src/sdk/models/operations/postuserssignindata.ts index d8e10d17..53aff1f9 100644 --- a/src/sdk/models/operations/postuserssignindata.ts +++ b/src/sdk/models/operations/postuserssignindata.ts @@ -16,25 +16,25 @@ export const PostUsersSignInDataServerList = [ export type PostUsersSignInDataGlobals = { /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; }; /** @@ -49,25 +49,25 @@ export type PostUsersSignInDataRequestBody = { export type PostUsersSignInDataRequest = { /** - * The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) + * An opaque identifier unique to the client (UUID, serial number, or other unique device ID) */ clientID?: string | undefined; /** - * The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.) + * The name of the client application. (Plex Web, Plex Media Server, etc.) */ clientName?: string | undefined; /** - * The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.) + * A relatively friendly name for the client device */ - deviceName?: string | undefined; + deviceNickname?: string | undefined; /** - * The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.) + * The version of the client application. */ clientVersion?: string | undefined; /** - * The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.) + * The platform of the client application. */ - clientPlatform?: string | undefined; + platform?: string | undefined; /** * Login credentials */ @@ -656,16 +656,16 @@ export const PostUsersSignInDataGlobals$inboundSchema: z.ZodType< > = z.object({ ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", }); }); @@ -673,9 +673,9 @@ export const PostUsersSignInDataGlobals$inboundSchema: z.ZodType< export type PostUsersSignInDataGlobals$Outbound = { ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; }; /** @internal */ @@ -686,16 +686,16 @@ export const PostUsersSignInDataGlobals$outboundSchema: z.ZodType< > = z.object({ clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", }); }); @@ -765,18 +765,18 @@ export const PostUsersSignInDataRequest$inboundSchema: z.ZodType< > = z.object({ ClientID: z.string().optional(), ClientName: z.string().optional(), - DeviceName: z.string().optional(), + DeviceNickname: z.string().optional(), ClientVersion: z.string().optional(), - ClientPlatform: z.string().optional(), + Platform: z.string().optional(), RequestBody: z.lazy(() => PostUsersSignInDataRequestBody$inboundSchema) .optional(), }).transform((v) => { return remap$(v, { "ClientID": "clientID", "ClientName": "clientName", - "DeviceName": "deviceName", + "DeviceNickname": "deviceNickname", "ClientVersion": "clientVersion", - "ClientPlatform": "clientPlatform", + "Platform": "platform", "RequestBody": "requestBody", }); }); @@ -785,9 +785,9 @@ export const PostUsersSignInDataRequest$inboundSchema: z.ZodType< export type PostUsersSignInDataRequest$Outbound = { ClientID?: string | undefined; ClientName?: string | undefined; - DeviceName?: string | undefined; + DeviceNickname?: string | undefined; ClientVersion?: string | undefined; - ClientPlatform?: string | undefined; + Platform?: string | undefined; RequestBody?: PostUsersSignInDataRequestBody$Outbound | undefined; }; @@ -799,18 +799,18 @@ export const PostUsersSignInDataRequest$outboundSchema: z.ZodType< > = z.object({ clientID: z.string().optional(), clientName: z.string().optional(), - deviceName: z.string().optional(), + deviceNickname: z.string().optional(), clientVersion: z.string().optional(), - clientPlatform: z.string().optional(), + platform: z.string().optional(), requestBody: z.lazy(() => PostUsersSignInDataRequestBody$outboundSchema) .optional(), }).transform((v) => { return remap$(v, { clientID: "ClientID", clientName: "ClientName", - deviceName: "DeviceName", + deviceNickname: "DeviceNickname", clientVersion: "ClientVersion", - clientPlatform: "ClientPlatform", + platform: "Platform", requestBody: "RequestBody", }); });