mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
242d7d78f2 | ||
|
|
779aa2dc9e |
@@ -3,10 +3,10 @@ id: 16f22cbf-f23f-4419-8924-3a4b06381947
|
|||||||
management:
|
management:
|
||||||
docChecksum: a91eaf9ec1e6a3a6f4bf0571f5b18bae
|
docChecksum: a91eaf9ec1e6a3a6f4bf0571f5b18bae
|
||||||
docVersion: 0.0.3
|
docVersion: 0.0.3
|
||||||
speakeasyVersion: 1.231.1
|
speakeasyVersion: 1.257.1
|
||||||
generationVersion: 2.295.1
|
generationVersion: 2.308.2
|
||||||
releaseVersion: 0.12.1
|
releaseVersion: 0.12.3
|
||||||
configChecksum: 8d21b1fe71b049ddde2e7694c17c983b
|
configChecksum: 752ce7e0cf6b7bbb5052a974f083e656
|
||||||
repoURL: https://github.com/LukeHagar/plexjs.git
|
repoURL: https://github.com/LukeHagar/plexjs.git
|
||||||
repoSubDirectory: .
|
repoSubDirectory: .
|
||||||
installationURL: https://github.com/LukeHagar/plexjs
|
installationURL: https://github.com/LukeHagar/plexjs
|
||||||
@@ -14,13 +14,13 @@ management:
|
|||||||
features:
|
features:
|
||||||
typescript:
|
typescript:
|
||||||
constsAndDefaults: 0.1.5
|
constsAndDefaults: 0.1.5
|
||||||
core: 3.7.0
|
core: 3.7.2
|
||||||
flattening: 2.81.1
|
flattening: 2.81.1
|
||||||
globalSecurity: 2.82.9
|
globalSecurity: 2.82.9
|
||||||
globalServerURLs: 2.82.4
|
globalServerURLs: 2.82.4
|
||||||
globals: 2.82.1
|
globals: 2.82.1
|
||||||
methodServerURLs: 2.82.1
|
methodServerURLs: 2.82.1
|
||||||
nameOverrides: 2.81.1
|
nameOverrides: 2.81.2
|
||||||
responseFormat: 0.2.3
|
responseFormat: 0.2.3
|
||||||
generatedFiles:
|
generatedFiles:
|
||||||
- src/sdk/server.ts
|
- src/sdk/server.ts
|
||||||
|
|||||||
21
.speakeasy/workflow.lock
Normal file
21
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
speakeasyVersion: 1.257.1
|
||||||
|
sources:
|
||||||
|
my-source: {}
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
source: my-source
|
||||||
|
outLocation: /github/workspace/repo
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
my-source:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||||
|
targets:
|
||||||
|
plexjs:
|
||||||
|
target: typescript
|
||||||
|
source: my-source
|
||||||
|
publish:
|
||||||
|
npm:
|
||||||
|
token: $NPM_TOKEN
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
inputs:
|
inputs:
|
||||||
|
|||||||
84
README.md
84
README.md
@@ -31,13 +31,13 @@ yarn add @lukehagar/plexjs
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -174,15 +174,15 @@ Validation errors can also occur when either method arguments or data returned f
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import * as errors from "@lukehagar/plexjs/models/errors";
|
import * as errors from "@lukehagar/plexjs/models/errors";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
let result;
|
let result;
|
||||||
try {
|
try {
|
||||||
result = await sdk.server.getServerCapabilities();
|
result = await plexAPI.server.getServerCapabilities();
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
switch (true) {
|
switch (true) {
|
||||||
case err instanceof errors.SDKValidationError: {
|
case err instanceof errors.SDKValidationError: {
|
||||||
@@ -225,14 +225,14 @@ You can override the default server globally by passing a server index to the `s
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
serverIdx: 0,
|
||||||
serverIdx: 0,
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -256,14 +256,14 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
serverURL: "{protocol}://{ip}:{port}",
|
||||||
serverURL: "{protocol}://{ip}:{port}",
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -279,15 +279,15 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const strong = false;
|
const strong = false;
|
||||||
const xPlexClientIdentifier = "<value>";
|
const xPlexClientIdentifier = "<value>";
|
||||||
|
|
||||||
const result = await sdk.plex.getPin(strong, xPlexClientIdentifier, {
|
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier, {
|
||||||
serverURL: "https://plex.tv/api/v2",
|
serverURL: "https://plex.tv/api/v2",
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -364,13 +364,13 @@ To authenticate with the API the `accessToken` parameter must be set when initia
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
@@ -412,15 +412,15 @@ This is used to track the client application and its usage
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const strong = false;
|
const strong = false;
|
||||||
const xPlexClientIdentifier = "<value>";
|
const xPlexClientIdentifier = "<value>";
|
||||||
|
|
||||||
const result = await sdk.plex.getPin(strong, xPlexClientIdentifier);
|
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
|
|||||||
20
RELEASES.md
20
RELEASES.md
@@ -299,3 +299,23 @@ Based on:
|
|||||||
- [typescript v0.12.1] .
|
- [typescript v0.12.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.12.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.1 - .
|
- [NPM v0.12.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.1 - .
|
||||||
|
|
||||||
|
## 2024-04-13 00:23:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.252.0 (2.306.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.2 - .
|
||||||
|
|
||||||
|
## 2024-04-18 00:26:16
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.12.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.12.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.3 - .
|
||||||
12
USAGE.md
12
USAGE.md
@@ -2,13 +2,13 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result);
|
console.log(result);
|
||||||
|
|||||||
@@ -26,13 +26,13 @@ Get Server Activities
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.activities.getServerActivities();
|
async function run() {
|
||||||
|
const result = await plexAPI.activities.getServerActivities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -68,15 +68,15 @@ Cancel Server Activities
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const activityUUID = "<value>";
|
const activityUUID = "<value>";
|
||||||
|
|
||||||
const result = await sdk.activities.cancelServerActivities(activityUUID);
|
const result = await plexAPI.activities.cancelServerActivities(activityUUID);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -22,16 +22,16 @@ This endpoint provides the caller with a temporary token with the same access le
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const type = GetTransientTokenQueryParamType.Delegation;
|
const type = GetTransientTokenQueryParamType.Delegation;
|
||||||
const scope = Scope.All;
|
const scope = Scope.All;
|
||||||
|
|
||||||
const result = await sdk.authentication.getTransientToken(type, scope);
|
const result = await plexAPI.authentication.getTransientToken(type, scope);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -71,15 +71,15 @@ Note: requires Plex Media Server >= 1.15.4.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const source = "server://client-identifier";
|
const source = "server://client-identifier";
|
||||||
|
|
||||||
const result = await sdk.authentication.getSourceConnectionInformation(source);
|
const result = await plexAPI.authentication.getSourceConnectionInformation(source);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -23,13 +23,13 @@ Returns a list of butler tasks
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.butler.getButlerTasks();
|
async function run() {
|
||||||
|
const result = await plexAPI.butler.getButlerTasks();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -70,13 +70,13 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.butler.startAllTasks();
|
async function run() {
|
||||||
|
const result = await plexAPI.butler.startAllTasks();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -113,13 +113,13 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.butler.stopAllTasks();
|
async function run() {
|
||||||
|
const result = await plexAPI.butler.stopAllTasks();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -161,15 +161,15 @@ This endpoint will attempt to start a single Butler task that is enabled in the
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { TaskName } from "@lukehagar/plexjs/models/operations";
|
import { TaskName } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const taskName = TaskName.CleanOldBundles;
|
const taskName = TaskName.CleanOldBundles;
|
||||||
|
|
||||||
const result = await sdk.butler.startTask(taskName);
|
const result = await plexAPI.butler.startTask(taskName);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -208,15 +208,15 @@ This endpoint will stop a currently running task by name, or remove it from the
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
|
import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const taskName = PathParamTaskName.BackupDatabase;
|
const taskName = PathParamTaskName.BackupDatabase;
|
||||||
|
|
||||||
const result = await sdk.butler.stopTask(taskName);
|
const result = await plexAPI.butler.stopTask(taskName);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -21,16 +21,16 @@ Get Global Hubs filtered by the parameters provided.
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
|
import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const count = 1262.49;
|
const count = 1262.49;
|
||||||
const onlyTransient = OnlyTransient.One;
|
const onlyTransient = OnlyTransient.One;
|
||||||
|
|
||||||
const result = await sdk.hubs.getGlobalHubs(count, onlyTransient);
|
const result = await plexAPI.hubs.getGlobalHubs(count, onlyTransient);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -70,17 +70,17 @@ This endpoint will return a list of library specific hubs
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
|
import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 6728.76;
|
const sectionId = 6728.76;
|
||||||
const count = 9010.22;
|
const count = 9010.22;
|
||||||
const onlyTransient = QueryParamOnlyTransient.Zero;
|
const onlyTransient = QueryParamOnlyTransient.Zero;
|
||||||
|
|
||||||
const result = await sdk.hubs.getLibraryHubs(sectionId, count, onlyTransient);
|
const result = await plexAPI.hubs.getLibraryHubs(sectionId, count, onlyTransient);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -29,16 +29,16 @@ This resource returns hash values for local files
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const url = "file://C:\Image.png&type=13";
|
const url = "file://C:\Image.png&type=13";
|
||||||
const type = 4462.17;
|
const type = 4462.17;
|
||||||
|
|
||||||
const result = await sdk.library.getFileHash(url, type);
|
const result = await plexAPI.library.getFileHash(url, type);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -77,13 +77,13 @@ This endpoint will return the recently added content.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.library.getRecentlyAdded();
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getRecentlyAdded();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -125,13 +125,13 @@ This allows a client to provide a rich interface around the media (e.g. allow so
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.library.getLibraries();
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getLibraries();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -207,16 +207,16 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
|
import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 1000;
|
const sectionId = 1000;
|
||||||
const includeDetails = IncludeDetails.Zero;
|
const includeDetails = IncludeDetails.Zero;
|
||||||
|
|
||||||
const result = await sdk.library.getLibrary(sectionId, includeDetails);
|
const result = await plexAPI.library.getLibrary(sectionId, includeDetails);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -254,15 +254,15 @@ Delate a library using a specific section
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 1000;
|
const sectionId = 1000;
|
||||||
|
|
||||||
const result = await sdk.library.deleteLibrary(sectionId);
|
const result = await plexAPI.library.deleteLibrary(sectionId);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -320,16 +320,16 @@ Fetches details from a specific section of the library identified by a section k
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Tag } from "@lukehagar/plexjs/models/operations";
|
import { Tag } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 451092;
|
const sectionId = 451092;
|
||||||
const tag = Tag.Unwatched;
|
const tag = Tag.Unwatched;
|
||||||
|
|
||||||
const result = await sdk.library.getLibraryItems(sectionId, tag);
|
const result = await plexAPI.library.getLibraryItems(sectionId, tag);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -367,15 +367,15 @@ This endpoint Refreshes the library.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 934.16;
|
const sectionId = 934.16;
|
||||||
|
|
||||||
const result = await sdk.library.refreshLibrary(sectionId);
|
const result = await plexAPI.library.refreshLibrary(sectionId);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -431,16 +431,16 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Type } from "@lukehagar/plexjs/models/operations";
|
import { Type } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sectionId = 933505;
|
const sectionId = 933505;
|
||||||
const type = Type.Four;
|
const type = Type.Four;
|
||||||
|
|
||||||
const result = await sdk.library.searchLibrary(sectionId, type);
|
const result = await plexAPI.library.searchLibrary(sectionId, type);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -478,15 +478,15 @@ This endpoint will return the metadata of a library item specified with the rati
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const ratingKey = 8382.31;
|
const ratingKey = 8382.31;
|
||||||
|
|
||||||
const result = await sdk.library.getMetadata(ratingKey);
|
const result = await plexAPI.library.getMetadata(ratingKey);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -524,15 +524,15 @@ This endpoint will return the children of of a library item specified with the r
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const ratingKey = 1539.14;
|
const ratingKey = 1539.14;
|
||||||
|
|
||||||
const result = await sdk.library.getMetadataChildren(ratingKey);
|
const result = await plexAPI.library.getMetadataChildren(ratingKey);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -570,13 +570,13 @@ This endpoint will return the on deck content.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.library.getOnDeck();
|
async function run() {
|
||||||
|
const result = await plexAPI.library.getOnDeck();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -23,17 +23,17 @@ This endpoint will write a single-line log message, including a level and source
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Level } from "@lukehagar/plexjs/models/operations";
|
import { Level } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const level = Level.Three;
|
const level = Level.Three;
|
||||||
const message = "Test log message";
|
const message = "Test log message";
|
||||||
const source = "Postman";
|
const source = "Postman";
|
||||||
|
|
||||||
const result = await sdk.log.logLine(level, message, source);
|
const result = await plexAPI.log.logLine(level, message, source);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -93,13 +93,13 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.log.logMultiLine("level=4&message=Test%20message%201&source=postman
|
async function run() {
|
||||||
|
const result = await plexAPI.log.logMultiLine("level=4&message=Test%20message%201&source=postman
|
||||||
level=3&message=Test%20message%202&source=postman
|
level=3&message=Test%20message%202&source=postman
|
||||||
level=1&message=Test%20message%203&source=postman");
|
level=1&message=Test%20message%203&source=postman");
|
||||||
|
|
||||||
@@ -139,13 +139,13 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.log.enablePaperTrail();
|
async function run() {
|
||||||
|
const result = await plexAPI.log.enablePaperTrail();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -21,15 +21,15 @@ This will mark the provided media key as Played.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const key = 59398;
|
const key = 59398;
|
||||||
|
|
||||||
const result = await sdk.media.markPlayed(key);
|
const result = await plexAPI.media.markPlayed(key);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -66,15 +66,15 @@ This will mark the provided media key as Unplayed.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const key = 59398;
|
const key = 59398;
|
||||||
|
|
||||||
const result = await sdk.media.markUnplayed(key);
|
const result = await plexAPI.media.markUnplayed(key);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -112,17 +112,17 @@ This API command can be used to update the play progress of a media item.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const key = "<value>";
|
const key = "<value>";
|
||||||
const time = 6900.91;
|
const time = 6900.91;
|
||||||
const state = "<value>";
|
const state = "<value>";
|
||||||
|
|
||||||
const result = await sdk.media.updatePlayProgress(key, time, state);
|
const result = await plexAPI.media.updatePlayProgress(key, time, state);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -34,13 +34,13 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations";
|
import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.playlists.createPlaylist({
|
async function run() {
|
||||||
|
const result = await plexAPI.playlists.createPlaylist({
|
||||||
title: "<value>",
|
title: "<value>",
|
||||||
type: QueryParamType.Photo,
|
type: QueryParamType.Photo,
|
||||||
smart: Smart.One,
|
smart: Smart.One,
|
||||||
@@ -83,16 +83,16 @@ Get All Playlists given the specified filters.
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operations";
|
import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistType = PlaylistType.Audio;
|
const playlistType = PlaylistType.Audio;
|
||||||
const smart = QueryParamSmart.Zero;
|
const smart = QueryParamSmart.Zero;
|
||||||
|
|
||||||
const result = await sdk.playlists.getPlaylists(playlistType, smart);
|
const result = await plexAPI.playlists.getPlaylists(playlistType, smart);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -132,15 +132,15 @@ Smart playlist details contain the `content` attribute. This is the content URI
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 4109.48;
|
const playlistID = 4109.48;
|
||||||
|
|
||||||
const result = await sdk.playlists.getPlaylist(playlistID);
|
const result = await plexAPI.playlists.getPlaylist(playlistID);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -178,15 +178,15 @@ This endpoint will delete a playlist
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 216.22;
|
const playlistID = 216.22;
|
||||||
|
|
||||||
const result = await sdk.playlists.deletePlaylist(playlistID);
|
const result = await plexAPI.playlists.deletePlaylist(playlistID);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -224,17 +224,17 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 3915;
|
const playlistID = 3915;
|
||||||
const title = "<value>";
|
const title = "<value>";
|
||||||
const summary = "<value>";
|
const summary = "<value>";
|
||||||
|
|
||||||
const result = await sdk.playlists.updatePlaylist(playlistID, title, summary);
|
const result = await plexAPI.playlists.updatePlaylist(playlistID, title, summary);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -277,16 +277,16 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 5004.46;
|
const playlistID = 5004.46;
|
||||||
const type = 9403.59;
|
const type = 9403.59;
|
||||||
|
|
||||||
const result = await sdk.playlists.getPlaylistContents(playlistID, type);
|
const result = await plexAPI.playlists.getPlaylistContents(playlistID, type);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -325,15 +325,15 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 1893.18;
|
const playlistID = 1893.18;
|
||||||
|
|
||||||
const result = await sdk.playlists.clearPlaylistContents(playlistID);
|
const result = await plexAPI.playlists.clearPlaylistContents(playlistID);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -372,17 +372,17 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const playlistID = 8502.01;
|
const playlistID = 8502.01;
|
||||||
const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1";
|
const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1";
|
||||||
const playQueueID = 123;
|
const playQueueID = 123;
|
||||||
|
|
||||||
const result = await sdk.playlists.addPlaylistContents(playlistID, uri, playQueueID);
|
const result = await plexAPI.playlists.addPlaylistContents(playlistID, uri, playQueueID);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -423,16 +423,16 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Force } from "@lukehagar/plexjs/models/operations";
|
import { Force } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const path = "/home/barkley/playlist.m3u";
|
const path = "/home/barkley/playlist.m3u";
|
||||||
const force = Force.Zero;
|
const force = Force.Zero;
|
||||||
|
|
||||||
const result = await sdk.playlists.uploadPlaylist(path, force);
|
const result = await plexAPI.playlists.uploadPlaylist(path, force);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -20,15 +20,15 @@ Retrieve a Pin from Plex.tv for authentication flows
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const strong = false;
|
const strong = false;
|
||||||
const xPlexClientIdentifier = "<value>";
|
const xPlexClientIdentifier = "<value>";
|
||||||
|
|
||||||
const result = await sdk.plex.getPin(strong, xPlexClientIdentifier);
|
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -67,15 +67,15 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const pinID = "<value>";
|
const pinID = "<value>";
|
||||||
const xPlexClientIdentifier = "<value>";
|
const xPlexClientIdentifier = "<value>";
|
||||||
|
|
||||||
const result = await sdk.plex.getToken(pinID, xPlexClientIdentifier);
|
const result = await plexAPI.plex.getToken(pinID, xPlexClientIdentifier);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -33,17 +33,17 @@ This request is intended to be very fast, and called as the user types.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const query = "dylan";
|
const query = "dylan";
|
||||||
const sectionId = 1516.53;
|
const sectionId = 1516.53;
|
||||||
const limit = 5;
|
const limit = 5;
|
||||||
|
|
||||||
const result = await sdk.search.performSearch(query, sectionId, limit);
|
const result = await plexAPI.search.performSearch(query, sectionId, limit);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -86,17 +86,17 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const query = "dead+poop";
|
const query = "dead+poop";
|
||||||
const sectionId = 4094.8;
|
const sectionId = 4094.8;
|
||||||
const limit = 5;
|
const limit = 5;
|
||||||
|
|
||||||
const result = await sdk.search.performVoiceSearch(query, sectionId, limit);
|
const result = await plexAPI.search.performVoiceSearch(query, sectionId, limit);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -135,15 +135,15 @@ This will search the database for the string provided.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const query = "110";
|
const query = "110";
|
||||||
|
|
||||||
const result = await sdk.search.getSearchResults(query);
|
const result = await plexAPI.search.getSearchResults(query);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -26,13 +26,13 @@ Server Capabilities
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerCapabilities();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerCapabilities();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -68,13 +68,13 @@ Get Server Preferences
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerPreferences();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerPreferences();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -110,13 +110,13 @@ Get Available Clients
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getAvailableClients();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getAvailableClients();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -152,13 +152,13 @@ Get Devices
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getDevices();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getDevices();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -194,13 +194,13 @@ Get Server Identity
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerIdentity();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerIdentity();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -236,13 +236,13 @@ Returns MyPlex Account Information
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getMyPlexAccount();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getMyPlexAccount();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -280,13 +280,13 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
|
import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getResizedPhoto({
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getResizedPhoto({
|
||||||
width: 110,
|
width: 110,
|
||||||
height: 165,
|
height: 165,
|
||||||
opacity: 100,
|
opacity: 100,
|
||||||
@@ -331,13 +331,13 @@ Get Server List
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.server.getServerList();
|
async function run() {
|
||||||
|
const result = await plexAPI.server.getServerList();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -22,13 +22,13 @@ This will retrieve the "Now Playing" Information of the PMS.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.sessions.getSessions();
|
async function run() {
|
||||||
|
const result = await plexAPI.sessions.getSessions();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -64,13 +64,13 @@ This will Retrieve a listing of all history views.
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.sessions.getSessionHistory();
|
async function run() {
|
||||||
|
const result = await plexAPI.sessions.getSessionHistory();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -106,13 +106,13 @@ Get Transcode Sessions
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.sessions.getTranscodeSessions();
|
async function run() {
|
||||||
|
const result = await plexAPI.sessions.getTranscodeSessions();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -148,15 +148,15 @@ Stop a Transcode Session
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const sessionKey = "zz7llzqlx8w9vnrsbnwhbmep";
|
const sessionKey = "zz7llzqlx8w9vnrsbnwhbmep";
|
||||||
|
|
||||||
const result = await sdk.sessions.stopTranscodeSession(sessionKey);
|
const result = await plexAPI.sessions.stopTranscodeSession(sessionKey);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -19,15 +19,15 @@ This will return the media statistics for the server
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const timespan = 411769;
|
const timespan = 411769;
|
||||||
|
|
||||||
const result = await sdk.statistics.getStatistics(timespan);
|
const result = await plexAPI.statistics.getStatistics(timespan);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -22,13 +22,13 @@ Querying status of updates
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.updater.getUpdateStatus();
|
async function run() {
|
||||||
|
const result = await plexAPI.updater.getUpdateStatus();
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -65,15 +65,15 @@ Checking for updates
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Download } from "@lukehagar/plexjs/models/operations";
|
import { Download } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const download = Download.One;
|
const download = Download.One;
|
||||||
|
|
||||||
const result = await sdk.updater.checkForUpdates(download);
|
const result = await plexAPI.updater.checkForUpdates(download);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
@@ -112,16 +112,16 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
|
import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
|
async function run() {
|
||||||
const tonight = Tonight.One;
|
const tonight = Tonight.One;
|
||||||
const skip = Skip.Zero;
|
const skip = Skip.Zero;
|
||||||
|
|
||||||
const result = await sdk.updater.applyUpdates(tonight, skip);
|
const result = await plexAPI.updater.applyUpdates(tonight, skip);
|
||||||
|
|
||||||
// Handle the result
|
// Handle the result
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|||||||
@@ -21,13 +21,13 @@ Get the timeline for a media item
|
|||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
import { State } from "@lukehagar/plexjs/models/operations";
|
import { State } from "@lukehagar/plexjs/models/operations";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.video.getTimeline({
|
async function run() {
|
||||||
|
const result = await plexAPI.video.getTimeline({
|
||||||
ratingKey: 716.56,
|
ratingKey: 716.56,
|
||||||
key: "<key>",
|
key: "<key>",
|
||||||
state: State.Paused,
|
state: State.Paused,
|
||||||
@@ -75,13 +75,13 @@ Begin a Universal Transcode Session
|
|||||||
```typescript
|
```typescript
|
||||||
import { PlexAPI } from "@lukehagar/plexjs";
|
import { PlexAPI } from "@lukehagar/plexjs";
|
||||||
|
|
||||||
async function run() {
|
const plexAPI = new PlexAPI({
|
||||||
const sdk = new PlexAPI({
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
accessToken: "<YOUR_API_KEY_HERE>",
|
xPlexClientIdentifier: "<value>",
|
||||||
xPlexClientIdentifier: "<value>",
|
});
|
||||||
});
|
|
||||||
|
|
||||||
const result = await sdk.video.startUniversalTranscode({
|
async function run() {
|
||||||
|
const result = await plexAPI.video.startUniversalTranscode({
|
||||||
hasMDE: 8924.99,
|
hasMDE: 8924.99,
|
||||||
path: "/etc/mail",
|
path: "/etc/mail",
|
||||||
mediaIndex: 9962.95,
|
mediaIndex: 9962.95,
|
||||||
|
|||||||
4
gen.yaml
4
gen.yaml
@@ -12,13 +12,15 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: false
|
oAuth2ClientCredentialsEnabled: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.12.1
|
version: 0.12.3
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
peerDependencies: {}
|
peerDependencies: {}
|
||||||
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@lukehagar/plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.12.1",
|
"version": "0.12.3",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@lukehagar/plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.12.1",
|
"version": "0.12.3",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jsonpath": "^0.2.4",
|
"@types/jsonpath": "^0.2.4",
|
||||||
"@typescript-eslint/eslint-plugin": "^6.13.2",
|
"@typescript-eslint/eslint-plugin": "^6.13.2",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@lukehagar/plexjs",
|
"name": "@lukehagar/plexjs",
|
||||||
"version": "0.12.1",
|
"version": "0.12.3",
|
||||||
"author": "LukeHagar",
|
"author": "LukeHagar",
|
||||||
"main": "./index.js",
|
"main": "./index.js",
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
@@ -14,7 +14,6 @@
|
|||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"prepare": "npm run build"
|
"prepare": "npm run build"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"zod": ">= 3"
|
"zod": ">= 3"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
|||||||
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.12.1",
|
sdkVersion: "0.12.3",
|
||||||
genVersion: "2.295.1",
|
genVersion: "2.308.2",
|
||||||
userAgent: "speakeasy-sdk/typescript 0.12.1 2.295.1 0.0.3 @lukehagar/plexjs",
|
userAgent: "speakeasy-sdk/typescript 0.12.3 2.308.2 0.0.3 @lukehagar/plexjs",
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user