Compare commits

...

10 Commits

Author SHA1 Message Date
speakeasybot
9b02d27d5e ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:12:41 +00:00
Luke Hagar
f200bc563f Delete README.md 2024-01-01 09:10:23 -06:00
speakeasy-bot
5c4b98300b 🐝 Add license. 2024-01-01 15:09:39 +00:00
speakeasy-bot
1e46343716 🐝 Update gen.yaml 2024-01-01 15:09:39 +00:00
speakeasy-bot
c34f35ba3d 🐝 Update workflow file 2024-01-01 15:09:38 +00:00
speakeasybot
b77c4d818f ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:06:15 +00:00
Luke Hagar
ea6e427d7b Delete README.md 2024-01-01 09:01:36 -06:00
speakeasy-bot
4ed36cd1a2 🐝 Add license. 2024-01-01 14:36:24 +00:00
speakeasy-bot
1b0b5c218c 🐝 Update gen.yaml 2024-01-01 14:36:24 +00:00
speakeasy-bot
e92eb2ba92 🐝 Update workflow file 2024-01-01 14:36:23 +00:00
23 changed files with 183 additions and 163 deletions

View File

@@ -1,4 +1,4 @@
# openapi # @lukehagar/plexjs
<div align="left"> <div align="left">
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -22,13 +22,13 @@ It has been generated successfully based on your OpenAPI spec. However, it is no
### NPM ### NPM
```bash ```bash
npm add openapi npm add @lukehagar/plexjs
``` ```
### Yarn ### Yarn
```bash ```bash
yarn add openapi yarn add @lukehagar/plexjs
``` ```
<!-- End SDK Installation [installation] --> <!-- End SDK Installation [installation] -->
@@ -38,10 +38,10 @@ yarn add openapi
### Example ### Example
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -173,11 +173,11 @@ All SDK methods return a response object or throw an error. If Error objects are
Example Example
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "openapi/models/errors"; import * as errors from "@lukehagar/plexjs/models/errors";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -246,8 +246,8 @@ custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors: to log errors:
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { HTTPClient } from "openapi/lib/http"; import { HTTPClient } from "@lukehagar/plexjs/lib/http";
const httpClient = new HTTPClient({ const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`. // fetcher takes a function that has the same signature as native `fetch`.
@@ -273,7 +273,7 @@ httpClient.addHook("requestError", (error, request) => {
console.groupEnd(); console.groupEnd();
}); });
const sdk = new SDK({ httpClient }); const sdk = new PlexAPI({ httpClient });
``` ```
<!-- End Custom HTTP Client [http-client] --> <!-- End Custom HTTP Client [http-client] -->
@@ -290,10 +290,10 @@ This SDK supports the following security scheme globally:
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -8,4 +8,24 @@ Based on:
### Generated ### Generated
- [typescript v0.1.0] . - [typescript v0.1.0] .
### Releases ### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - . - [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - .
## 2024-01-01 15:05:18
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.2.0] .
### Releases
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
## 2024-01-01 15:11:44
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .

View File

@@ -1,9 +1,9 @@
<!-- Start SDK Example Usage [usage] --> <!-- Start SDK Example Usage [usage] -->
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -24,10 +24,10 @@ Get Server Activities
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -68,10 +68,10 @@ Cancel Server Activities
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -21,10 +21,10 @@ Returns a list of butler tasks
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -70,10 +70,10 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -115,10 +115,10 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -164,11 +164,11 @@ This endpoint will attempt to start a single Butler task that is enabled in the
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "openapi/models/operations"; import { TaskName } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -213,11 +213,11 @@ This endpoint will stop a currently running task by name, or remove it from the
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "openapi/models/operations"; import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -18,11 +18,11 @@ Get Global Hubs filtered by the parameters provided.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { OnlyTransient } from "openapi/models/operations"; import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -69,11 +69,11 @@ This endpoint will return a list of library specific hubs
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamOnlyTransient } from "openapi/models/operations"; import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -28,10 +28,10 @@ This resource returns hash values for local files
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -78,10 +78,10 @@ This endpoint will return the recently added content.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -128,10 +128,10 @@ This allows a client to provide a rich interface around the media (e.g. allow so
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -191,11 +191,11 @@ Returns details for the library. This can be thought of as an interstitial endpo
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeDetails } from "openapi/models/operations"; import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -241,10 +241,10 @@ Delate a library using a specific section
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -289,10 +289,10 @@ This endpoint will return a list of library items filtered by the filter and typ
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -341,10 +341,10 @@ This endpoint Refreshes the library.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -389,10 +389,10 @@ This endpoint will return a list of the latest library items filtered by the fil
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -441,10 +441,10 @@ Represents a "Common" item. It contains only the common attributes of the items
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -493,10 +493,10 @@ This endpoint will return the metadata of a library item specified with the rati
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -541,10 +541,10 @@ This endpoint will return the children of of a library item specified with the r
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -589,10 +589,10 @@ This endpoint will return the on deck content.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -20,11 +20,11 @@ This endpoint will write a single-line log message, including a level and source
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { Level } from "openapi/models/operations"; import { Level } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -73,10 +73,10 @@ This endpoint will write multiple lines to the main Plex Media Server log in a s
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -118,10 +118,10 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -19,10 +19,10 @@ This will mark the provided media key as Played.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -66,10 +66,10 @@ This will mark the provided media key as Unplayed.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -114,10 +114,10 @@ This API command can be used to update the play progress of a media item.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -31,11 +31,11 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { Smart, TypeT } from "openapi/models/operations"; import { Smart, TypeT } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -81,11 +81,11 @@ Get All Playlists given the specified filters.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { PlaylistType, QueryParamSmart } from "openapi/models/operations"; import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -133,10 +133,10 @@ Smart playlist details contain the `content` attribute. This is the content URI
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -181,10 +181,10 @@ This endpoint will delete a playlist
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -229,10 +229,10 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -280,10 +280,10 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -330,10 +330,10 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -379,10 +379,10 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -431,11 +431,11 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { Force } from "openapi/models/operations"; import { Force } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -1,4 +1,4 @@
# SDK # PlexAPI SDK
## Overview ## Overview

View File

@@ -31,10 +31,10 @@ This request is intended to be very fast, and called as the user types.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -86,10 +86,10 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -137,10 +137,10 @@ This will search the database for the string provided.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -19,11 +19,11 @@ This endpoint provides the caller with a temporary token with the same access le
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamType, Scope } from "openapi/models/operations"; import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -71,10 +71,10 @@ Note: requires Plex Media Server >= 1.15.4.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -24,10 +24,10 @@ Server Capabilities
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -68,10 +68,10 @@ Get Server Preferences
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -112,10 +112,10 @@ Get Available Clients
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -156,10 +156,10 @@ Get Devices
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -200,10 +200,10 @@ Get Server Identity
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -244,10 +244,10 @@ Returns MyPlex Account Information
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -289,11 +289,11 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { MinSize, Upscale } from "openapi/models/operations"; import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -343,10 +343,10 @@ Get Server List
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -20,10 +20,10 @@ This will retrieve the "Now Playing" Information of the PMS.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -64,10 +64,10 @@ This will Retrieve a listing of all history views.
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -108,10 +108,10 @@ Get Transcode Sessions
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -152,10 +152,10 @@ Stop a Transcode Session
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -20,10 +20,10 @@ Querying status of updates
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -64,11 +64,11 @@ Checking for updates
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { Download } from "openapi/models/operations"; import { Download } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -113,11 +113,11 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { Skip, Tonight } from "openapi/models/operations"; import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -18,10 +18,10 @@ Begin a Universal Transcode Session
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });
@@ -69,11 +69,11 @@ Get the timeline for a media item
### Example Usage ### Example Usage
```typescript ```typescript
import { SDK } from "openapi"; import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "openapi/models/operations"; import { State } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new SDK({ const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
}); });

View File

@@ -439,7 +439,7 @@ docs/models/errors/startuniversaltranscoderesponsebody.md
docs/models/errors/gettimelineerrors.md docs/models/errors/gettimelineerrors.md
docs/models/errors/gettimelineresponsebody.md docs/models/errors/gettimelineresponsebody.md
docs/models/components/security.md docs/models/components/security.md
docs/sdks/sdk/README.md docs/sdks/plexapi/README.md
docs/sdks/server/README.md docs/sdks/server/README.md
docs/sdks/media/README.md docs/sdks/media/README.md
docs/sdks/activities/README.md docs/sdks/activities/README.md

View File

@@ -6,13 +6,13 @@ management:
generationVersion: 2.223.3 generationVersion: 2.223.3
generation: generation:
comments: {} comments: {}
sdkClassName: SDK sdkClassName: Plex-API
repoURL: https://github.com/LukeHagar/plexjs.git repoURL: https://github.com/LukeHagar/plexjs.git
maintainOpenAPIOrder: true maintainOpenAPIOrder: true
usageSnippets: usageSnippets:
optionalPropertyRendering: withExample optionalPropertyRendering: withExample
fixes: fixes:
nameResolutionDec2023: true nameResolutionDec2023: false
useClassNamesForArrayFields: true useClassNamesForArrayFields: true
features: features:
typescript: typescript:
@@ -22,8 +22,8 @@ features:
globalServerURLs: 2.82.1 globalServerURLs: 2.82.1
nameOverrides: 2.81.1 nameOverrides: 2.81.1
typescript: typescript:
version: 0.1.0 version: 0.3.0
author: Speakeasy author: LukeHagar
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
flattenGlobalSecurity: true flattenGlobalSecurity: true
imports: imports:
@@ -38,7 +38,7 @@ typescript:
installationURL: https://github.com/LukeHagar/plexjs installationURL: https://github.com/LukeHagar/plexjs
maxMethodParams: 4 maxMethodParams: 4
outputModelSuffix: output outputModelSuffix: output
packageName: openapi packageName: '@lukehagar/plexjs'
published: true published: true
repoSubDirectory: . repoSubDirectory: .
templateVersion: v2 templateVersion: v2

8
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "openapi", "name": "@lukehagar/plexjs",
"version": "0.1.0", "version": "0.3.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "openapi", "name": "@lukehagar/plexjs",
"version": "0.1.0", "version": "0.3.0",
"dependencies": { "dependencies": {
"decimal.js": "^10.4.3", "decimal.js": "^10.4.3",
"jsonpath": "^1.1.1" "jsonpath": "^1.1.1"

View File

@@ -1,8 +1,8 @@
{ {
"type": "commonjs", "type": "commonjs",
"name": "openapi", "name": "@lukehagar/plexjs",
"version": "0.1.0", "version": "0.3.0",
"author": "Speakeasy", "author": "LukeHagar",
"main": "./index.js", "main": "./index.js",
"sideEffects": false, "sideEffects": false,
"repository": { "repository": {

View File

@@ -84,7 +84,7 @@ export function serverURLFromOptions(options: SDKOptions): URL {
export const SDK_METADATA = Object.freeze({ export const SDK_METADATA = Object.freeze({
language: "typescript", language: "typescript",
openapiDocVersion: "0.0.3", openapiDocVersion: "0.0.3",
sdkVersion: "0.1.0", sdkVersion: "0.3.0",
genVersion: "2.223.3", genVersion: "2.223.3",
userAgent: "speakeasy-sdk/typescript 0.1.0 2.223.3 0.0.3 openapi", userAgent: "speakeasy-sdk/typescript 0.3.0 2.223.3 0.0.3 @lukehagar/plexjs",
}); });

View File

@@ -19,7 +19,7 @@ import { Sessions } from "./sessions";
import { Updater } from "./updater"; import { Updater } from "./updater";
import { Video } from "./video"; import { Video } from "./video";
export class SDK extends ClientSDK { export class PlexAPI extends ClientSDK {
private readonly options$: SDKOptions; private readonly options$: SDKOptions;
constructor(options: SDKOptions = {}) { constructor(options: SDKOptions = {}) {