Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 14 KB

README.md

File metadata and controls

100 lines (67 loc) · 14 KB
Raw

Plex

(plex)

Overview

API Calls that perform operations directly against https://Plex.tv

Available Operations

getPin

Retrieve a Pin from Plex.tv for authentication flows

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.plex.getPin(false, "Postman");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description Example
strong boolean ➖ Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for Plex.tv/link
xPlexClientIdentifier string ➖ The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
 [object Object]
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ 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 ➖ An optional server URL to use. http://localhost:8080

Response

Promise<operations.GetPinResponse>

Errors

Error Object Status Code Content Type
errors.GetPinResponseBody 400 application/json
errors.SDKError 4xx-5xx /

getToken

Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.plex.getToken("<value>", "Postman");

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter Type Required Description Example
pinID string ✔️ The PinID to retrieve an access token for
xPlexClientIdentifier string ➖ The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
 [object Object]
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ 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 ➖ An optional server URL to use. http://localhost:8080

Response

Promise<operations.GetTokenResponse>

Errors

Error Object Status Code Content Type
errors.GetTokenResponseBody 400 application/json
errors.SDKError 4xx-5xx /