mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9b02d27d5e | ||
|
|
f200bc563f | ||
|
|
5c4b98300b | ||
|
|
1e46343716 | ||
|
|
c34f35ba3d |
18
README.md
18
README.md
@@ -1,4 +1,4 @@
|
|||||||
# plexjs
|
# @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 plexjs
|
npm add @lukehagar/plexjs
|
||||||
```
|
```
|
||||||
|
|
||||||
### Yarn
|
### Yarn
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn add plexjs
|
yarn add @lukehagar/plexjs
|
||||||
```
|
```
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ yarn add plexjs
|
|||||||
### Example
|
### Example
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -173,8 +173,8 @@ All SDK methods return a response object or throw an error. If Error objects are
|
|||||||
Example
|
Example
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import * as errors from "plexjs/models/errors";
|
import * as errors from "@lukehagar/plexjs/models/errors";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -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 { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { HTTPClient } from "plexjs/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`.
|
||||||
@@ -290,7 +290,7 @@ 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 { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
10
RELEASES.md
10
RELEASES.md
@@ -19,3 +19,13 @@ Based on:
|
|||||||
- [typescript v0.2.0] .
|
- [typescript v0.2.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
|
- [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 - .
|
||||||
2
USAGE.md
2
USAGE.md
@@ -1,6 +1,6 @@
|
|||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Get Server Activities
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -68,7 +68,7 @@ Cancel Server Activities
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Returns a list of butler tasks
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -70,7 +70,7 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -115,7 +115,7 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -164,8 +164,8 @@ This endpoint will attempt to start a single Butler task that is enabled in the
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { TaskName } from "plexjs/models/operations";
|
import { TaskName } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -213,8 +213,8 @@ This endpoint will stop a currently running task by name, or remove it from the
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { PathParamTaskName } from "plexjs/models/operations";
|
import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -18,8 +18,8 @@ Get Global Hubs filtered by the parameters provided.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { OnlyTransient } from "plexjs/models/operations";
|
import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -69,8 +69,8 @@ This endpoint will return a list of library specific hubs
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamOnlyTransient } from "plexjs/models/operations";
|
import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ This resource returns hash values for local files
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -78,7 +78,7 @@ This endpoint will return the recently added content.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -128,7 +128,7 @@ This allows a client to provide a rich interface around the media (e.g. allow so
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -191,8 +191,8 @@ Returns details for the library. This can be thought of as an interstitial endpo
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { IncludeDetails } from "plexjs/models/operations";
|
import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -241,7 +241,7 @@ Delate a library using a specific section
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -289,7 +289,7 @@ This endpoint will return a list of library items filtered by the filter and typ
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -341,7 +341,7 @@ This endpoint Refreshes the library.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -389,7 +389,7 @@ This endpoint will return a list of the latest library items filtered by the fil
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -441,7 +441,7 @@ Represents a "Common" item. It contains only the common attributes of the items
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -493,7 +493,7 @@ This endpoint will return the metadata of a library item specified with the rati
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -541,7 +541,7 @@ This endpoint will return the children of of a library item specified with the r
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -589,7 +589,7 @@ This endpoint will return the on deck content.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -20,8 +20,8 @@ This endpoint will write a single-line log message, including a level and source
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Level } from "plexjs/models/operations";
|
import { Level } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -73,7 +73,7 @@ This endpoint will write multiple lines to the main Plex Media Server log in a s
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -118,7 +118,7 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ This will mark the provided media key as Played.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -66,7 +66,7 @@ This will mark the provided media key as Unplayed.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -114,7 +114,7 @@ This API command can be used to update the play progress of a media item.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -31,8 +31,8 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Smart, TypeT } from "plexjs/models/operations";
|
import { Smart, TypeT } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -81,8 +81,8 @@ Get All Playlists given the specified filters.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { PlaylistType, QueryParamSmart } from "plexjs/models/operations";
|
import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -133,7 +133,7 @@ Smart playlist details contain the `content` attribute. This is the content URI
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -181,7 +181,7 @@ This endpoint will delete a playlist
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -229,7 +229,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -280,7 +280,7 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -330,7 +330,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -379,7 +379,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -431,8 +431,8 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Force } from "plexjs/models/operations";
|
import { Force } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ This request is intended to be very fast, and called as the user types.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -86,7 +86,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -137,7 +137,7 @@ This will search the database for the string provided.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -19,8 +19,8 @@ This endpoint provides the caller with a temporary token with the same access le
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamType, Scope } from "plexjs/models/operations";
|
import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -71,7 +71,7 @@ Note: requires Plex Media Server >= 1.15.4.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Server Capabilities
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -68,7 +68,7 @@ Get Server Preferences
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -112,7 +112,7 @@ Get Available Clients
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -156,7 +156,7 @@ Get Devices
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -200,7 +200,7 @@ Get Server Identity
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -244,7 +244,7 @@ Returns MyPlex Account Information
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -289,8 +289,8 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { MinSize, Upscale } from "plexjs/models/operations";
|
import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -343,7 +343,7 @@ Get Server List
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ This will retrieve the "Now Playing" Information of the PMS.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -64,7 +64,7 @@ This will Retrieve a listing of all history views.
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -108,7 +108,7 @@ Get Transcode Sessions
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -152,7 +152,7 @@ Stop a Transcode Session
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ Querying status of updates
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -64,8 +64,8 @@ Checking for updates
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Download } from "plexjs/models/operations";
|
import { Download } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -113,8 +113,8 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Skip, Tonight } from "plexjs/models/operations";
|
import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Begin a Universal Transcode Session
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
@@ -69,8 +69,8 @@ Get the timeline for a media item
|
|||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { State } from "plexjs/models/operations";
|
import { State } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const sdk = new PlexAPI({
|
const sdk = new PlexAPI({
|
||||||
|
|||||||
4
gen.yaml
4
gen.yaml
@@ -22,7 +22,7 @@ features:
|
|||||||
globalServerURLs: 2.82.1
|
globalServerURLs: 2.82.1
|
||||||
nameOverrides: 2.81.1
|
nameOverrides: 2.81.1
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.2.0
|
version: 0.3.0
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
@@ -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: plexjs
|
packageName: '@lukehagar/plexjs'
|
||||||
published: true
|
published: true
|
||||||
repoSubDirectory: .
|
repoSubDirectory: .
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
|
|||||||
8
package-lock.json
generated
8
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.2.0",
|
"version": "0.3.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.2.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"
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"type": "commonjs",
|
"type": "commonjs",
|
||||||
"name": "plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.2.0",
|
"version": "0.3.0",
|
||||||
"author": "LukeHagar",
|
"author": "LukeHagar",
|
||||||
"main": "./index.js",
|
"main": "./index.js",
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
|
|||||||
@@ -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.2.0",
|
sdkVersion: "0.3.0",
|
||||||
genVersion: "2.223.3",
|
genVersion: "2.223.3",
|
||||||
userAgent: "speakeasy-sdk/typescript 0.2.0 2.223.3 0.0.3 plexjs",
|
userAgent: "speakeasy-sdk/typescript 0.3.0 2.223.3 0.0.3 @lukehagar/plexjs",
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user