Compare commits

...

3 Commits

Author SHA1 Message Date
speakeasybot
ed63eb13b9 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.615.2 2025-09-15 00:13:35 +00:00
speakeasybot
442b11c11a ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.598.3 2025-08-07 00:14:07 +00:00
speakeasybot
c56a0f5d3c ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.598.0 2025-08-06 00:13:53 +00:00
30 changed files with 588 additions and 689 deletions

View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: 16f22cbf-f23f-4419-8924-3a4b06381947
management:
docChecksum: 4a7c64e455521ea3ac1e4957e621f694
docChecksum: dd151459f079aa5c974ad9f0015d580a
docVersion: 0.0.3
speakeasyVersion: 1.580.1
generationVersion: 2.656.3
releaseVersion: 0.40.0
configChecksum: 3e8220b93e9fb4f5d3c6500daf058fae
speakeasyVersion: 1.615.2
generationVersion: 2.698.4
releaseVersion: 0.40.3
configChecksum: da34b6fc69cb6f59e054eff389118e32
repoURL: https://github.com/LukeHagar/plexjs.git
repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexjs
@@ -15,7 +15,7 @@ features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.12
core: 3.21.14
core: 3.21.22
defaultEnabledRetries: 0.1.0
deprecations: 2.81.1
downloadStreams: 0.1.1
@@ -24,7 +24,7 @@ features:
envVarSecurityUsage: 0.1.2
errors: 2.86.0
flattening: 2.82.1
globalSecurity: 2.82.13
globalSecurity: 2.82.14
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.5

View File

@@ -16,12 +16,13 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
hoistGlobalSecurity: true
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.40.0
version: 0.40.3
additionalDependencies:
dependencies: {}
devDependencies: {}
@@ -55,5 +56,7 @@ typescript:
outputModelSuffix: output
packageName: '@lukehagar/plexjs'
responseFormat: envelope
sseFlatResponse: false
templateVersion: v2
usageSDKInitImports: []
useIndexModules: true

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.580.1
speakeasyVersion: 1.615.2
sources:
my-source:
sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b4fa89a3571fbdcb4228800772a5fe1c292170babcd3e055161ae54402f89577
sourceBlobDigest: sha256:f84dd2bfdaea4074454cea3c7fbc6c9e05515c5e9e961abb4923b77f8faf48f1
sourceRevisionDigest: sha256:5125adfea1b0daea399c6ecf755e32795de6b4131465ae6a1f32ad73b3bc7787
sourceBlobDigest: sha256:95cea18b6e5f7d76d35db0aba5bcb59e72cf204451a2b09a99be0e3e9ec1f4c0
tags:
- latest
- speakeasy-sdk-regen-1752106317
- speakeasy-sdk-regen-1757895128
- 0.0.3
targets:
plexjs:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b4fa89a3571fbdcb4228800772a5fe1c292170babcd3e055161ae54402f89577
sourceBlobDigest: sha256:f84dd2bfdaea4074454cea3c7fbc6c9e05515c5e9e961abb4923b77f8faf48f1
sourceRevisionDigest: sha256:5125adfea1b0daea399c6ecf755e32795de6b4131465ae6a1f32ad73b3bc7787
sourceBlobDigest: sha256:95cea18b6e5f7d76d35db0aba5bcb59e72cf204451a2b09a99be0e3e9ec1f4c0
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:a4ed38eeac4610af5ac9189665922e6cad283ce730eb8b1a20dd4857afda3fd3
codeSamplesRevisionDigest: sha256:1e2d6fa14f87b947de490bc7f88a36b2e43145643385bd8f728c7cdc69b56086
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

View File

@@ -1368,4 +1368,34 @@ Based on:
### Generated
- [typescript v0.40.0] .
### Releases
- [NPM v0.40.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.0 - .
- [NPM v0.40.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.0 - .
## 2025-08-06 00:12:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.598.0 (2.674.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.40.1] .
### Releases
- [NPM v0.40.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.1 - .
## 2025-08-07 00:12:28
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.598.3 (2.674.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.40.2] .
### Releases
- [NPM v0.40.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.2 - .
## 2025-09-15 00:11:38
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.40.3] .
### Releases
- [NPM v0.40.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.3 - .

View File

@@ -23,6 +23,7 @@ Get Server Activities
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getServerActivities" method="get" path="/activities" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -92,6 +93,7 @@ Cancel Server Activities
### Example Usage
<!-- UsageSnippet language="typescript" operationID="cancelServerActivities" method="delete" path="/activities/{activityUUID}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -20,6 +20,7 @@ This endpoint provides the caller with a temporary token with the same access le
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTransientToken" method="get" path="/security/token" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
@@ -95,6 +96,7 @@ Note: requires Plex Media Server >= 1.15.4.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getSourceConnectionInformation" method="get" path="/security/resources" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -165,6 +167,7 @@ Get the User data from the provided X-Plex-Token
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTokenDetails" method="get" path="/user" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -235,6 +238,7 @@ Sign in user with username and password and return user data with Plex authentic
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post-users-sign-in-data" method="post" path="/users/signin" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -20,6 +20,7 @@ Returns a list of butler tasks
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getButlerTasks" method="get" path="/butler" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -94,6 +95,7 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
### Example Usage
<!-- UsageSnippet language="typescript" operationID="startAllTasks" method="post" path="/butler" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -164,6 +166,7 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
### Example Usage
<!-- UsageSnippet language="typescript" operationID="stopAllTasks" method="delete" path="/butler" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -238,6 +241,7 @@ This endpoint will attempt to start a single Butler task that is enabled in the
### Example Usage
<!-- UsageSnippet language="typescript" operationID="startTask" method="post" path="/butler/{taskName}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
@@ -311,6 +315,7 @@ This endpoint will stop a currently running task by name, or remove it from the
### Example Usage
<!-- UsageSnippet language="typescript" operationID="stopTask" method="delete" path="/butler/{taskName}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";

View File

@@ -18,6 +18,7 @@ Get Global Hubs filtered by the parameters provided.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getGlobalHubs" method="get" path="/hubs" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -90,6 +91,7 @@ This endpoint will return the recently added content.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-recently-added" method="get" path="/hubs/home/recentlyAdded" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";
@@ -171,6 +173,7 @@ This endpoint will return a list of library specific hubs
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getLibraryHubs" method="get" path="/hubs/sections/{sectionId}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -35,6 +35,7 @@ This resource returns hash values for local files
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getFileHash" method="get" path="/library/hashes" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -107,6 +108,7 @@ This endpoint will return the recently added content.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-recently-added-library" method="get" path="/library/recentlyAdded" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamIncludeMeta, QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -223,6 +225,7 @@ This allows a client to provide a rich interface around the media (e.g. allow so
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-all-libraries" method="get" path="/library/sections" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -331,6 +334,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-library-details" method="get" path="/library/sections/{sectionKey}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -402,6 +406,7 @@ Delete a library using a specific section id
### Example Usage
<!-- UsageSnippet language="typescript" operationID="deleteLibrary" method="delete" path="/library/sections/{sectionKey}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -493,6 +498,7 @@ Fetches details from a specific section of the library identified by a section k
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-library-items" method="get" path="/library/sections/{sectionKey}/{tag}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
@@ -588,6 +594,7 @@ Retrieves a list of all general media data for this library.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-library-sections-all" method="get" path="/library/sections/{sectionKey}/all" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
@@ -691,6 +698,7 @@ This endpoint Refreshes all the Metadata of the library.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-refresh-library-metadata" method="get" path="/library/sections/{sectionKey}/refresh" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
@@ -782,6 +790,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-search-library" method="get" path="/library/sections/{sectionKey}/search" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -856,6 +865,7 @@ Retrieves a list of all the genres that are found for the media in this library.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-genres-library" method="get" path="/library/sections/{sectionKey}/genre" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -930,6 +940,7 @@ Retrieves a list of all the countries that are found for the media in this libra
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-countries-library" method="get" path="/library/sections/{sectionKey}/country" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1004,6 +1015,7 @@ Retrieves a list of all the actors that are found for the media in this library.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-actors-library" method="get" path="/library/sections/{sectionKey}/actor" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1078,6 +1090,7 @@ Search the provided query across all library sections, or a single section, and
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-search-all-libraries" method="get" path="/library/search" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import {
@@ -1176,6 +1189,7 @@ Multiple rating keys can be provided as a comma-separated list (e.g., "21119,216
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-media-meta-data" method="get" path="/library/metadata/{ratingKey}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1276,6 +1290,7 @@ Returns the background artwork for a library item.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-media-arts" method="get" path="/library/metadata/{ratingKey}/arts" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1344,6 +1359,7 @@ Uploads an image to use as the background artwork for a library item, either fro
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post-media-arts" method="post" path="/library/metadata/{ratingKey}/arts" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1414,6 +1430,7 @@ Returns the available posters for a library item.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-media-posters" method="get" path="/library/metadata/{ratingKey}/posters" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1482,6 +1499,7 @@ Uploads a poster to a library item, either from a local file or a remote URL
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post-media-poster" method="post" path="/library/metadata/{ratingKey}/posters" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1553,6 +1571,7 @@ This endpoint will return the children of of a library item specified with the r
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getMetadataChildren" method="get" path="/library/metadata/{ratingKey}/children" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1625,6 +1644,7 @@ This endpoint will return the top watched content from libraries of a certain ty
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTopWatchedContent" method="get" path="/library/all/top" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";

View File

@@ -19,6 +19,7 @@ This endpoint will write a single-line log message, including a level and source
### Example Usage
<!-- UsageSnippet language="typescript" operationID="logLine" method="get" path="/log" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
@@ -114,6 +115,7 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="logMultiLine" method="post" path="/log" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -189,6 +191,7 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
### Example Usage
<!-- UsageSnippet language="typescript" operationID="enablePaperTrail" method="get" path="/log/networked" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -20,6 +20,7 @@ This will mark the provided media key as Played.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="markPlayed" method="get" path="/:/scrobble" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -90,6 +91,7 @@ This will mark the provided media key as Unplayed.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="markUnplayed" method="get" path="/:/unscrobble" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -161,6 +163,7 @@ This API command can be used to update the play progress of a media item.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="updatePlayProgress" method="post" path="/:/progress" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -233,6 +236,7 @@ Gets the banner image of the media item
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-banner-image" method="get" path="/library/metadata/{ratingKey}/banner" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -317,6 +321,7 @@ Gets the thumbnail image of the media item
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-thumb-image" method="get" path="/library/metadata/{ratingKey}/thumb" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -30,6 +30,7 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
### Example Usage
<!-- UsageSnippet language="typescript" operationID="createPlaylist" method="post" path="/playlists" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
@@ -112,6 +113,7 @@ Get All Playlists given the specified filters.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getPlaylists" method="get" path="/playlists" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -185,6 +187,7 @@ Smart playlist details contain the `content` attribute. This is the content URI
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getPlaylist" method="get" path="/playlists/{playlistID}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -256,6 +259,7 @@ This endpoint will delete a playlist
### Example Usage
<!-- UsageSnippet language="typescript" operationID="deletePlaylist" method="delete" path="/playlists/{playlistID}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -327,6 +331,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
### Example Usage
<!-- UsageSnippet language="typescript" operationID="updatePlaylist" method="put" path="/playlists/{playlistID}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -403,6 +408,7 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getPlaylistContents" method="get" path="/playlists/{playlistID}/items" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -477,6 +483,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="clearPlaylistContents" method="delete" path="/playlists/{playlistID}/items" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -549,6 +556,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
### Example Usage
<!-- UsageSnippet language="typescript" operationID="addPlaylistContents" method="put" path="/playlists/{playlistID}/items" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -622,6 +630,7 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
### Example Usage
<!-- UsageSnippet language="typescript" operationID="uploadPlaylist" method="post" path="/playlists/upload" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";

View File

@@ -22,6 +22,7 @@ Get Companions Data
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getCompanionsData" method="get" path="/companions" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -92,6 +93,7 @@ Get friends of provided auth token.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getUserFriends" method="get" path="/friends" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -162,6 +164,7 @@ Returns the geolocation and locale data of the caller
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getGeoData" method="get" path="/geoip" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -228,6 +231,7 @@ Retrieves the home data for the authenticated user, including details like home
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getHomeData" method="get" path="/home" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -297,6 +301,7 @@ Get Plex server access tokens and server connections
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-server-resources" method="get" path="/resources" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -371,6 +376,7 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getPin" method="post" path="/pins" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -449,6 +455,7 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTokenByPinId" method="get" path="/pins/{pinID}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -30,6 +30,7 @@ This request is intended to be very fast, and called as the user types.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="performSearch" method="get" path="/hubs/search" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -106,6 +107,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
### Example Usage
<!-- UsageSnippet language="typescript" operationID="performVoiceSearch" method="get" path="/hubs/search/voice" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -178,6 +180,7 @@ This will search the database for the string provided.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getSearchResults" method="get" path="/search" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -24,6 +24,7 @@ Get Server Capabilities
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getServerCapabilities" method="get" path="/" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -93,6 +94,7 @@ Get Server Preferences
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getServerPreferences" method="get" path="/:/prefs" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -162,6 +164,7 @@ Get Available Clients
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getAvailableClients" method="get" path="/clients" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -231,6 +234,7 @@ Get Devices
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getDevices" method="get" path="/devices" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -300,6 +304,7 @@ This request is useful to determine if the server is online or offline
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-server-identity" method="get" path="/identity" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -364,6 +369,7 @@ Returns MyPlex Account Information
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getMyPlexAccount" method="get" path="/myplex/account" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -434,6 +440,7 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getResizedPhoto" method="get" path="/photo/:/transcode" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
@@ -520,6 +527,7 @@ Retrieves media providers and their features from the Plex server.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-media-providers" method="get" path="/media/providers" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -590,6 +598,7 @@ Get Server List
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getServerList" method="get" path="/servers" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -19,6 +19,7 @@ This will retrieve the "Now Playing" Information of the PMS.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getSessions" method="get" path="/status/sessions" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -88,6 +89,7 @@ This will Retrieve a listing of all history views.
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getSessionHistory" method="get" path="/status/sessions/history/all" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -161,6 +163,7 @@ Get Transcode Sessions
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTranscodeSessions" method="get" path="/transcode/sessions" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -230,6 +233,7 @@ Stop a Transcode Session
### Example Usage
<!-- UsageSnippet language="typescript" operationID="stopTranscodeSession" method="delete" path="/transcode/sessions/{sessionKey}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -18,6 +18,7 @@ This will return the media statistics for the server
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getStatistics" method="get" path="/statistics/media" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -88,6 +89,7 @@ This will return the resources for the server
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getResourcesStatistics" method="get" path="/statistics/resources" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -158,6 +160,7 @@ This will return the bandwidth statistics for the server
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getBandwidthStatistics" method="get" path="/statistics/bandwidth" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -19,6 +19,7 @@ Querying status of updates
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getUpdateStatus" method="get" path="/updater/status" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
@@ -88,6 +89,7 @@ Checking for updates
### Example Usage
<!-- UsageSnippet language="typescript" operationID="checkForUpdates" method="put" path="/updater/check" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
@@ -161,6 +163,7 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
### Example Usage
<!-- UsageSnippet language="typescript" operationID="applyUpdates" method="put" path="/updater/apply" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";

View File

@@ -13,6 +13,7 @@ Get list of all users that are friends and have library access with the provided
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-users" method="get" path="/users" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -17,6 +17,7 @@ Get the timeline for a media item
### Example Usage
<!-- UsageSnippet language="typescript" operationID="getTimeline" method="get" path="/:/timeline" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "@lukehagar/plexjs/sdk/models/operations";
@@ -111,6 +112,7 @@ Begin a Universal Transcode Session
### Example Usage
<!-- UsageSnippet language="typescript" operationID="startUniversalTranscode" method="get" path="/video/:/transcode/universal/start.mpd" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -16,6 +16,7 @@ Get User Watchlist
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get-watch-list" method="get" path="/library/sections/watchlist/{filter}" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";

View File

@@ -24,3 +24,8 @@ To run an example file from the examples directory:
npm run build && npx tsx example.ts
```
## Creating new examples
Duplicate an existing example file, they won't be overwritten by the generation process.

View File

@@ -18,17 +18,16 @@
},
"..": {
"name": "@lukehagar/plexjs",
"version": "0.40.0",
"version": "0.40.3",
"dependencies": {
"zod": "^3.20.0"
},
"devDependencies": {
"@eslint/js": "^9.19.0",
"eslint": "^9.19.0",
"globals": "^15.14.0",
"typescript": "^5.4.5",
"typescript-eslint": "^8.22.0",
"zod": "^3.25.17"
},
"peerDependencies": {
"zod": "^3"
"typescript": "~5.8.3",
"typescript-eslint": "^8.26.0"
}
},
"node_modules/@esbuild/aix-ppc64": {

View File

@@ -2,11 +2,13 @@
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import dotenv from "dotenv";
dotenv.config();
/**
* Example usage of the @lukehagar/plexjs SDK
*
* To run this example from the examples directory:
* npm run build && npx tsx serverGetServerCapabilities.ts
* npm run build && npx tsx serverGetServerCapabilities.example.ts
*/
import { PlexAPI } from "@lukehagar/plexjs";
@@ -16,7 +18,7 @@ const plexAPI = new PlexAPI({
});
async function main() {
const result = await plexAPI.getServerCapabilities();
const result = await plexAPI.server.getServerCapabilities();
console.log(result);
}

View File

@@ -2,7 +2,7 @@
{
"name": "@lukehagar/plexjs",
"version": "0.40.0",
"version": "0.40.3",
"exports": {
".": "./src/index.ts",
"./sdk/models/errors": "./src/sdk/models/errors/index.ts",

1076
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "@lukehagar/plexjs",
"version": "0.40.0",
"version": "0.40.3",
"author": "LukeHagar",
"main": "./index.js",
"sideEffects": false,
@@ -15,17 +15,16 @@
"prepublishOnly": "npm run build"
},
"peerDependencies": {
"zod": "^3"
},
"devDependencies": {
"@eslint/js": "^9.19.0",
"eslint": "^9.19.0",
"globals": "^15.14.0",
"typescript": "^5.4.5",
"typescript-eslint": "^8.22.0",
"zod": "^3.25.17"
"typescript": "~5.8.3",
"typescript-eslint": "^8.26.0"
},
"dependencies": {
"zod": "^3.20.0"
}
}

View File

@@ -94,7 +94,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
export const SDK_METADATA = {
language: "typescript",
openapiDocVersion: "0.0.3",
sdkVersion: "0.40.0",
genVersion: "2.656.3",
userAgent: "speakeasy-sdk/typescript 0.40.0 2.656.3 0.0.3 @lukehagar/plexjs",
sdkVersion: "0.40.3",
genVersion: "2.698.4",
userAgent: "speakeasy-sdk/typescript 0.40.3 2.698.4 0.0.3 @lukehagar/plexjs",
} as const;

View File

@@ -83,7 +83,10 @@ type SecurityInputOAuth2 = {
type SecurityInputOAuth2ClientCredentials = {
type: "oauth2:client_credentials";
value:
| { clientID?: string | undefined; clientSecret?: string | undefined }
| {
clientID?: string | undefined;
clientSecret?: string | undefined;
}
| null
| string
| undefined;

View File

@@ -16,9 +16,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export const GetWatchListServerList = [
/**
* The plex metadata provider server
* The plex discover provider server
*/
"https://metadata.provider.plex.tv",
"https://discover.provider.plex.tv",
] as const;
/**