mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c4dd496e24 | ||
|
|
cdda7f840f | ||
|
|
2c04752d88 |
@@ -1,5 +1,4 @@
|
||||
/*
|
||||
/docs/**/*.md
|
||||
**/*
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.map
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
||||
management:
|
||||
docChecksum: a91eaf9ec1e6a3a6f4bf0571f5b18bae
|
||||
docChecksum: 7a43cd3413d535205cfaee20a4b6a250
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: 1.257.1
|
||||
generationVersion: 2.308.2
|
||||
releaseVersion: 0.12.3
|
||||
configChecksum: 752ce7e0cf6b7bbb5052a974f083e656
|
||||
speakeasyVersion: 1.267.2
|
||||
generationVersion: 2.312.1
|
||||
releaseVersion: 0.13.1
|
||||
configChecksum: 1ff69678442629cebb3690db99f39502
|
||||
repoURL: https://github.com/LukeHagar/plexjs.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/plexjs
|
||||
@@ -14,7 +14,7 @@ management:
|
||||
features:
|
||||
typescript:
|
||||
constsAndDefaults: 0.1.5
|
||||
core: 3.7.2
|
||||
core: 3.8.0
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.82.9
|
||||
globalServerURLs: 2.82.4
|
||||
@@ -42,6 +42,7 @@ generatedFiles:
|
||||
- .eslintrc.js
|
||||
- .npmignore
|
||||
- RUNTIMES.md
|
||||
- jsr.json
|
||||
- package.json
|
||||
- src/index.ts
|
||||
- src/lib/base64.ts
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.257.1
|
||||
speakeasyVersion: 1.267.2
|
||||
sources:
|
||||
my-source: {}
|
||||
targets:
|
||||
|
||||
20
README.md
20
README.md
@@ -33,7 +33,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -176,7 +176,7 @@ import * as errors from "@lukehagar/plexjs/models/errors";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -228,7 +228,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverIdx: 0,
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -259,7 +259,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
const plexAPI = new PlexAPI({
|
||||
serverURL: "{protocol}://{ip}:{port}",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -280,12 +280,12 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const strong = false;
|
||||
const xPlexClientIdentifier = "<value>";
|
||||
const xPlexClientIdentifier = "Postman";
|
||||
|
||||
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier, {
|
||||
serverURL: "https://plex.tv/api/v2",
|
||||
@@ -366,7 +366,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -392,7 +392,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||
|
||||
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
@@ -413,12 +413,12 @@ This is used to track the client application and its usage
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const strong = false;
|
||||
const xPlexClientIdentifier = "<value>";
|
||||
const xPlexClientIdentifier = "Postman";
|
||||
|
||||
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);
|
||||
|
||||
|
||||
30
RELEASES.md
30
RELEASES.md
@@ -319,3 +319,33 @@ Based on:
|
||||
- [typescript v0.12.3] .
|
||||
### Releases
|
||||
- [NPM v0.12.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.3 - .
|
||||
|
||||
## 2024-04-19 00:26:47
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.13.0] .
|
||||
### Releases
|
||||
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||
|
||||
## 2024-04-20 00:26:02
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.267.0 (2.312.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.13.0] .
|
||||
### Releases
|
||||
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
|
||||
|
||||
## 2024-04-22 16:14:48
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.13.1] .
|
||||
### Releases
|
||||
- [NPM v0.13.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.1 - .
|
||||
2
USAGE.md
2
USAGE.md
@@ -4,7 +4,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
|
||||
@@ -28,7 +28,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -70,7 +70,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -24,7 +24,7 @@ import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -73,7 +73,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -25,7 +25,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -72,7 +72,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -115,7 +115,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -163,7 +163,7 @@ import { TaskName } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -210,7 +210,7 @@ import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -23,7 +23,7 @@ import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -72,7 +72,7 @@ import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -31,7 +31,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -79,7 +79,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -127,7 +127,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -209,7 +209,7 @@ import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -256,7 +256,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -322,7 +322,7 @@ import { Tag } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -369,7 +369,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -433,7 +433,7 @@ import { Type } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -480,7 +480,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -526,7 +526,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -572,7 +572,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -25,7 +25,7 @@ import { Level } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -95,7 +95,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -141,7 +141,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -23,7 +23,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -68,7 +68,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -114,7 +114,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -36,7 +36,7 @@ import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -85,7 +85,7 @@ import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operatio
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -134,7 +134,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -180,7 +180,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -226,7 +226,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -279,7 +279,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -327,7 +327,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -374,7 +374,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -425,7 +425,7 @@ import { Force } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -21,12 +21,12 @@ Retrieve a Pin from Plex.tv for authentication flows
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const strong = false;
|
||||
const xPlexClientIdentifier = "<value>";
|
||||
const xPlexClientIdentifier = "Postman";
|
||||
|
||||
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);
|
||||
|
||||
@@ -39,13 +39,13 @@ run();
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
|
||||
|
||||
|
||||
### Response
|
||||
@@ -68,12 +68,12 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const pinID = "<value>";
|
||||
const xPlexClientIdentifier = "<value>";
|
||||
const xPlexClientIdentifier = "Postman";
|
||||
|
||||
const result = await plexAPI.plex.getToken(pinID, xPlexClientIdentifier);
|
||||
|
||||
@@ -86,13 +86,13 @@ run();
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
@@ -35,7 +35,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -88,7 +88,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -137,7 +137,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -28,7 +28,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -70,7 +70,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -112,7 +112,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -154,7 +154,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -196,7 +196,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -238,7 +238,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -282,7 +282,7 @@ import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -333,7 +333,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -24,7 +24,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -66,7 +66,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -108,7 +108,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -150,7 +150,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -21,7 +21,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -24,7 +24,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -67,7 +67,7 @@ import { Download } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -114,7 +114,7 @@ import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
@@ -23,7 +23,7 @@ import { State } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
@@ -77,7 +77,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "<value>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
|
||||
2
gen.yaml
2
gen.yaml
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
typescript:
|
||||
version: 0.12.3
|
||||
version: 0.13.1
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
26
jsr.json
Normal file
26
jsr.json
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
|
||||
{
|
||||
"name": "@lukehagar/plexjs",
|
||||
"version": "0.13.1",
|
||||
"exports": {
|
||||
".": "./src/index.ts",
|
||||
"./models/errors": "./src/models/errors/index.ts",
|
||||
"./models/components": "./src/models/components/index.ts",
|
||||
"./models/operations": "./src/models/operations/index.ts",
|
||||
"./lib/config": "./src/lib/config.ts",
|
||||
"./lib/http": "./src/lib/http.ts",
|
||||
"./lib/retries": "./src/lib/retries.ts",
|
||||
"./lib/sdks": "./src/lib/sdks.ts",
|
||||
"./types": "./src/types/index.ts"
|
||||
},
|
||||
"publish": {
|
||||
"include": [
|
||||
"LICENSE",
|
||||
"README.md",
|
||||
"RUNTIMES.md",
|
||||
"USAGE.md",
|
||||
"src/**/*.ts"
|
||||
]
|
||||
}
|
||||
}
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@lukehagar/plexjs",
|
||||
"version": "0.12.3",
|
||||
"version": "0.13.1",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@lukehagar/plexjs",
|
||||
"version": "0.12.3",
|
||||
"version": "0.13.1",
|
||||
"devDependencies": {
|
||||
"@types/jsonpath": "^0.2.4",
|
||||
"@typescript-eslint/eslint-plugin": "^6.13.2",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@lukehagar/plexjs",
|
||||
"version": "0.12.3",
|
||||
"version": "0.13.1",
|
||||
"author": "LukeHagar",
|
||||
"main": "./index.js",
|
||||
"sideEffects": false,
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
import { HTTPClient } from "./http";
|
||||
import { RetryConfig } from "./retries";
|
||||
import { pathToFunc } from "./url";
|
||||
import { Params, pathToFunc } from "./url";
|
||||
|
||||
/**
|
||||
* Contains the list of servers available to the SDK
|
||||
@@ -62,14 +62,14 @@ export type SDKOptions = {
|
||||
export function serverURLFromOptions(options: SDKOptions): URL | null {
|
||||
let serverURL = options.serverURL;
|
||||
|
||||
const serverParams = [
|
||||
const serverParams: Params[] = [
|
||||
{
|
||||
protocol: options.protocol?.toString() ?? "http",
|
||||
ip: options.ip?.toString() ?? "10.10.10.47",
|
||||
port: options.port?.toString() ?? "32400",
|
||||
protocol: options.protocol ?? "http",
|
||||
ip: options.ip ?? "10.10.10.47",
|
||||
port: options.port ?? "32400",
|
||||
},
|
||||
];
|
||||
let params: Record<string, string> = {};
|
||||
let params: Params = {};
|
||||
|
||||
if (!serverURL) {
|
||||
const serverIdx = options.serverIdx ?? 0;
|
||||
@@ -84,10 +84,10 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
||||
return new URL(u);
|
||||
}
|
||||
|
||||
export const SDK_METADATA = Object.freeze({
|
||||
export const SDK_METADATA = {
|
||||
language: "typescript",
|
||||
openapiDocVersion: "0.0.3",
|
||||
sdkVersion: "0.12.3",
|
||||
genVersion: "2.308.2",
|
||||
userAgent: "speakeasy-sdk/typescript 0.12.3 2.308.2 0.0.3 @lukehagar/plexjs",
|
||||
});
|
||||
sdkVersion: "0.13.1",
|
||||
genVersion: "2.312.1",
|
||||
userAgent: "speakeasy-sdk/typescript 0.13.1 2.312.1 0.0.3 @lukehagar/plexjs",
|
||||
} as const;
|
||||
|
||||
@@ -15,7 +15,7 @@ export function encodeMatrix(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -65,7 +65,7 @@ export function encodeLabel(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -100,7 +100,13 @@ export function encodeLabel(
|
||||
return out;
|
||||
}
|
||||
|
||||
function formEncoder(sep: string) {
|
||||
type FormEncoder = (
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) => string;
|
||||
|
||||
function formEncoder(sep: string): FormEncoder {
|
||||
return (
|
||||
key: string,
|
||||
value: unknown,
|
||||
@@ -157,7 +163,7 @@ export function encodeBodyForm(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -200,7 +206,7 @@ export function encodeDeepObject(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
if (value == null) {
|
||||
return "";
|
||||
}
|
||||
@@ -247,7 +253,7 @@ export function encodeJSON(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
if (typeof value === "undefined") {
|
||||
return "";
|
||||
}
|
||||
@@ -265,7 +271,7 @@ export const encodeSimple = (
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) => {
|
||||
): string => {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -337,7 +343,7 @@ function serializeValue(value: unknown): string {
|
||||
return `${value}`;
|
||||
}
|
||||
|
||||
function jsonReplacer(_: string, value: unknown) {
|
||||
function jsonReplacer(_: string, value: unknown): unknown {
|
||||
if (value instanceof Uint8Array) {
|
||||
return bytesToBase64(value);
|
||||
} else {
|
||||
|
||||
@@ -7,7 +7,7 @@ export type Fetcher = (
|
||||
init?: RequestInit,
|
||||
) => Promise<Response>;
|
||||
|
||||
type Awaitable<T> = T | Promise<T>;
|
||||
export type Awaitable<T> = T | Promise<T>;
|
||||
|
||||
const DEFAULT_FETCHER: Fetcher = (input, init) => fetch(input, init);
|
||||
|
||||
@@ -15,9 +15,9 @@ export interface HTTPClientOptions {
|
||||
fetcher?: Fetcher;
|
||||
}
|
||||
|
||||
type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
|
||||
type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
|
||||
type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
|
||||
export type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
|
||||
export type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
|
||||
export type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
|
||||
|
||||
export class HTTPClient {
|
||||
private fetcher: Fetcher;
|
||||
@@ -100,7 +100,7 @@ export class HTTPClient {
|
||||
| [hook: "beforeRequest", fn: BeforeRequestHook]
|
||||
| [hook: "requestError", fn: RequestErrorHook]
|
||||
| [hook: "response", fn: ResponseHook]
|
||||
) {
|
||||
): this {
|
||||
let target: unknown[];
|
||||
if (args[0] === "beforeRequest") {
|
||||
target = this.requestHooks;
|
||||
@@ -120,7 +120,7 @@ export class HTTPClient {
|
||||
return this;
|
||||
}
|
||||
|
||||
clone() {
|
||||
clone(): HTTPClient {
|
||||
const child = new HTTPClient(this.options);
|
||||
child.requestHooks = this.requestHooks.slice();
|
||||
child.requestErrorHooks = this.requestErrorHooks.slice();
|
||||
@@ -160,7 +160,7 @@ const codeRangeRE = new RegExp("^[0-9]xx$", "i");
|
||||
export function matchStatusCode(
|
||||
response: Response,
|
||||
codes: number | string | (number | string)[],
|
||||
) {
|
||||
): boolean {
|
||||
const actual = `${response.status}`;
|
||||
const expectedCodes = Array.isArray(codes) ? codes : [codes];
|
||||
if (!expectedCodes.length) {
|
||||
|
||||
@@ -40,7 +40,7 @@ export class ClientSDK {
|
||||
this.client = client;
|
||||
}
|
||||
|
||||
protected createRequest$(conf: RequestConfig, options?: RequestOptions) {
|
||||
protected createRequest$(conf: RequestConfig, options?: RequestOptions): Request {
|
||||
const { method, path, query, headers: opHeaders, security } = conf;
|
||||
|
||||
const base = conf.baseURL ?? this.baseURL;
|
||||
@@ -109,7 +109,7 @@ export class ClientSDK {
|
||||
context: HookContext;
|
||||
errorCodes: number | string | (number | string)[];
|
||||
}
|
||||
) {
|
||||
): Promise<Response> {
|
||||
const { context, errorCodes } = options;
|
||||
|
||||
let response = await this.client.request(await this.hooks$.beforeRequest(context, req));
|
||||
|
||||
@@ -169,7 +169,9 @@ function applyBearer(
|
||||
|
||||
state.headers[spec.fieldName] = value;
|
||||
}
|
||||
export function resolveGlobalSecurity(security: Partial<components.Security> | null | undefined) {
|
||||
export function resolveGlobalSecurity(
|
||||
security: Partial<components.Security> | null | undefined
|
||||
): SecurityState | null {
|
||||
return resolveSecurity([
|
||||
{
|
||||
fieldName: "X-Plex-Token",
|
||||
|
||||
@@ -4,10 +4,12 @@
|
||||
|
||||
const hasOwn = Object.prototype.hasOwnProperty;
|
||||
|
||||
export type Params = Partial<Record<string, string | number>>;
|
||||
|
||||
export function pathToFunc(
|
||||
pathPattern: string,
|
||||
options?: { charEncoding?: "percent" | "none" },
|
||||
): (params?: Record<string, string | number>) => string {
|
||||
): (params?: Params) => string {
|
||||
const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
|
||||
|
||||
return function buildURLPath(params: Record<string, unknown> = {}): string {
|
||||
|
||||
@@ -17,7 +17,7 @@ export class SDKValidationError extends Error {
|
||||
this.rawValue = rawValue;
|
||||
}
|
||||
|
||||
public override toString() {
|
||||
public override toString(): string {
|
||||
return `${this.message}: ${this.cause}`;
|
||||
}
|
||||
|
||||
@@ -26,7 +26,7 @@ export class SDKValidationError extends Error {
|
||||
* is a ZodError or some other recognized error type, otherwise return the
|
||||
* default error message.
|
||||
*/
|
||||
public pretty() {
|
||||
public pretty(): string {
|
||||
if (this.cause instanceof z.ZodError) {
|
||||
return `${this.message}\n${formatZodError(this.cause)}`;
|
||||
} else {
|
||||
|
||||
@@ -47,10 +47,10 @@ export type ApplyUpdatesResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Tonight$ = z.nativeEnum(Tonight);
|
||||
export const Tonight$: z.ZodNativeEnum<typeof Tonight> = z.nativeEnum(Tonight);
|
||||
|
||||
/** @internal */
|
||||
export const Skip$ = z.nativeEnum(Skip);
|
||||
export const Skip$: z.ZodNativeEnum<typeof Skip> = z.nativeEnum(Skip);
|
||||
|
||||
/** @internal */
|
||||
export namespace ApplyUpdatesRequest$ {
|
||||
|
||||
@@ -35,7 +35,7 @@ export type CheckForUpdatesResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Download$ = z.nativeEnum(Download);
|
||||
export const Download$: z.ZodNativeEnum<typeof Download> = z.nativeEnum(Download);
|
||||
|
||||
/** @internal */
|
||||
export namespace CheckForUpdatesRequest$ {
|
||||
|
||||
@@ -95,10 +95,10 @@ export type CreatePlaylistResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const QueryParamType$ = z.nativeEnum(QueryParamType);
|
||||
export const QueryParamType$: z.ZodNativeEnum<typeof QueryParamType> = z.nativeEnum(QueryParamType);
|
||||
|
||||
/** @internal */
|
||||
export const Smart$ = z.nativeEnum(Smart);
|
||||
export const Smart$: z.ZodNativeEnum<typeof Smart> = z.nativeEnum(Smart);
|
||||
|
||||
/** @internal */
|
||||
export namespace CreatePlaylistRequest$ {
|
||||
|
||||
@@ -91,7 +91,7 @@ export type GetGlobalHubsResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const OnlyTransient$ = z.nativeEnum(OnlyTransient);
|
||||
export const OnlyTransient$: z.ZodNativeEnum<typeof OnlyTransient> = z.nativeEnum(OnlyTransient);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetGlobalHubsRequest$ {
|
||||
|
||||
@@ -128,7 +128,7 @@ export type GetLibraryResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const IncludeDetails$ = z.nativeEnum(IncludeDetails);
|
||||
export const IncludeDetails$: z.ZodNativeEnum<typeof IncludeDetails> = z.nativeEnum(IncludeDetails);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetLibraryRequest$ {
|
||||
|
||||
@@ -170,7 +170,8 @@ export type GetLibraryHubsResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const QueryParamOnlyTransient$ = z.nativeEnum(QueryParamOnlyTransient);
|
||||
export const QueryParamOnlyTransient$: z.ZodNativeEnum<typeof QueryParamOnlyTransient> =
|
||||
z.nativeEnum(QueryParamOnlyTransient);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetLibraryHubsRequest$ {
|
||||
|
||||
@@ -194,7 +194,7 @@ export type GetLibraryItemsResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Tag$ = z.nativeEnum(Tag);
|
||||
export const Tag$: z.ZodNativeEnum<typeof Tag> = z.nativeEnum(Tag);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetLibraryItemsRequest$ {
|
||||
|
||||
@@ -83,10 +83,11 @@ export type GetPlaylistsResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const PlaylistType$ = z.nativeEnum(PlaylistType);
|
||||
export const PlaylistType$: z.ZodNativeEnum<typeof PlaylistType> = z.nativeEnum(PlaylistType);
|
||||
|
||||
/** @internal */
|
||||
export const QueryParamSmart$ = z.nativeEnum(QueryParamSmart);
|
||||
export const QueryParamSmart$: z.ZodNativeEnum<typeof QueryParamSmart> =
|
||||
z.nativeEnum(QueryParamSmart);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetPlaylistsRequest$ {
|
||||
|
||||
@@ -67,10 +67,10 @@ export type GetResizedPhotoResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const MinSize$ = z.nativeEnum(MinSize);
|
||||
export const MinSize$: z.ZodNativeEnum<typeof MinSize> = z.nativeEnum(MinSize);
|
||||
|
||||
/** @internal */
|
||||
export const Upscale$ = z.nativeEnum(Upscale);
|
||||
export const Upscale$: z.ZodNativeEnum<typeof Upscale> = z.nativeEnum(Upscale);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetResizedPhotoRequest$ {
|
||||
|
||||
@@ -72,7 +72,7 @@ export type GetTimelineResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const State$ = z.nativeEnum(State);
|
||||
export const State$: z.ZodNativeEnum<typeof State> = z.nativeEnum(State);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetTimelineRequest$ {
|
||||
|
||||
@@ -45,10 +45,12 @@ export type GetTransientTokenResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const GetTransientTokenQueryParamType$ = z.nativeEnum(GetTransientTokenQueryParamType);
|
||||
export const GetTransientTokenQueryParamType$: z.ZodNativeEnum<
|
||||
typeof GetTransientTokenQueryParamType
|
||||
> = z.nativeEnum(GetTransientTokenQueryParamType);
|
||||
|
||||
/** @internal */
|
||||
export const Scope$ = z.nativeEnum(Scope);
|
||||
export const Scope$: z.ZodNativeEnum<typeof Scope> = z.nativeEnum(Scope);
|
||||
|
||||
/** @internal */
|
||||
export namespace GetTransientTokenRequest$ {
|
||||
|
||||
@@ -62,7 +62,7 @@ export type LogLineResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Level$ = z.nativeEnum(Level);
|
||||
export const Level$: z.ZodNativeEnum<typeof Level> = z.nativeEnum(Level);
|
||||
|
||||
/** @internal */
|
||||
export namespace LogLineRequest$ {
|
||||
|
||||
@@ -91,7 +91,7 @@ export type SearchLibraryResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Type$ = z.nativeEnum(Type);
|
||||
export const Type$: z.ZodNativeEnum<typeof Type> = z.nativeEnum(Type);
|
||||
|
||||
/** @internal */
|
||||
export namespace SearchLibraryRequest$ {
|
||||
|
||||
@@ -47,7 +47,7 @@ export type StartTaskResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const TaskName$ = z.nativeEnum(TaskName);
|
||||
export const TaskName$: z.ZodNativeEnum<typeof TaskName> = z.nativeEnum(TaskName);
|
||||
|
||||
/** @internal */
|
||||
export namespace StartTaskRequest$ {
|
||||
|
||||
@@ -47,7 +47,8 @@ export type StopTaskResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const PathParamTaskName$ = z.nativeEnum(PathParamTaskName);
|
||||
export const PathParamTaskName$: z.ZodNativeEnum<typeof PathParamTaskName> =
|
||||
z.nativeEnum(PathParamTaskName);
|
||||
|
||||
/** @internal */
|
||||
export namespace StopTaskRequest$ {
|
||||
|
||||
@@ -59,7 +59,7 @@ export type UploadPlaylistResponse = {
|
||||
};
|
||||
|
||||
/** @internal */
|
||||
export const Force$ = z.nativeEnum(Force);
|
||||
export const Force$: z.ZodNativeEnum<typeof Force> = z.nativeEnum(Force);
|
||||
|
||||
/** @internal */
|
||||
export namespace UploadPlaylistRequest$ {
|
||||
|
||||
@@ -50,77 +50,77 @@ export class PlexAPI extends ClientSDK {
|
||||
}
|
||||
|
||||
private _server?: Server;
|
||||
get server() {
|
||||
get server(): Server {
|
||||
return (this._server ??= new Server(this.options$));
|
||||
}
|
||||
|
||||
private _media?: Media;
|
||||
get media() {
|
||||
get media(): Media {
|
||||
return (this._media ??= new Media(this.options$));
|
||||
}
|
||||
|
||||
private _video?: Video;
|
||||
get video() {
|
||||
get video(): Video {
|
||||
return (this._video ??= new Video(this.options$));
|
||||
}
|
||||
|
||||
private _activities?: Activities;
|
||||
get activities() {
|
||||
get activities(): Activities {
|
||||
return (this._activities ??= new Activities(this.options$));
|
||||
}
|
||||
|
||||
private _butler?: Butler;
|
||||
get butler() {
|
||||
get butler(): Butler {
|
||||
return (this._butler ??= new Butler(this.options$));
|
||||
}
|
||||
|
||||
private _hubs?: Hubs;
|
||||
get hubs() {
|
||||
get hubs(): Hubs {
|
||||
return (this._hubs ??= new Hubs(this.options$));
|
||||
}
|
||||
|
||||
private _search?: Search;
|
||||
get search() {
|
||||
get search(): Search {
|
||||
return (this._search ??= new Search(this.options$));
|
||||
}
|
||||
|
||||
private _library?: Library;
|
||||
get library() {
|
||||
get library(): Library {
|
||||
return (this._library ??= new Library(this.options$));
|
||||
}
|
||||
|
||||
private _log?: Log;
|
||||
get log() {
|
||||
get log(): Log {
|
||||
return (this._log ??= new Log(this.options$));
|
||||
}
|
||||
|
||||
private _plex?: Plex;
|
||||
get plex() {
|
||||
get plex(): Plex {
|
||||
return (this._plex ??= new Plex(this.options$));
|
||||
}
|
||||
|
||||
private _playlists?: Playlists;
|
||||
get playlists() {
|
||||
get playlists(): Playlists {
|
||||
return (this._playlists ??= new Playlists(this.options$));
|
||||
}
|
||||
|
||||
private _authentication?: Authentication;
|
||||
get authentication() {
|
||||
get authentication(): Authentication {
|
||||
return (this._authentication ??= new Authentication(this.options$));
|
||||
}
|
||||
|
||||
private _statistics?: Statistics;
|
||||
get statistics() {
|
||||
get statistics(): Statistics {
|
||||
return (this._statistics ??= new Statistics(this.options$));
|
||||
}
|
||||
|
||||
private _sessions?: Sessions;
|
||||
get sessions() {
|
||||
get sessions(): Sessions {
|
||||
return (this._sessions ??= new Sessions(this.options$));
|
||||
}
|
||||
|
||||
private _updater?: Updater;
|
||||
get updater() {
|
||||
get updater(): Updater {
|
||||
return (this._updater ??= new Updater(this.options$));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,10 +4,11 @@
|
||||
|
||||
import * as z from "zod";
|
||||
|
||||
export const blobLikeSchema = z.custom<Blob>(isBlobLike, {
|
||||
export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
|
||||
z.custom<Blob>(isBlobLike, {
|
||||
message: "expected a Blob, File or Blob-like object",
|
||||
fatal: true,
|
||||
});
|
||||
});
|
||||
|
||||
export function isBlobLike(val: unknown): val is Blob {
|
||||
if (val instanceof Blob) {
|
||||
|
||||
@@ -11,7 +11,7 @@ export type PageIterator<Result> = Result & {
|
||||
|
||||
export function createPageIterator<Result>(
|
||||
page: Result & { next: Paginator<Result> },
|
||||
) {
|
||||
): { [Symbol.asyncIterator]: () => AsyncIterableIterator<Result> } {
|
||||
return {
|
||||
[Symbol.asyncIterator]: async function* paginator() {
|
||||
yield page;
|
||||
|
||||
@@ -10,7 +10,7 @@ export class RFCDate {
|
||||
/**
|
||||
* Creates a new RFCDate instance using today's date.
|
||||
*/
|
||||
static today() {
|
||||
static today(): RFCDate {
|
||||
return new RFCDate(new Date());
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user