mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 20:47:47 +00:00
103 lines
12 KiB
Markdown
103 lines
12 KiB
Markdown
# Plex
|
|
(*plex*)
|
|
|
|
## Overview
|
|
|
|
API Calls that perform operations directly against https://Plex.tv
|
|
|
|
|
|
### Available Operations
|
|
|
|
* [getPin](#getpin) - Get a Pin
|
|
* [getToken](#gettoken) - Get Access Token
|
|
|
|
## getPin
|
|
|
|
Retrieve a Pin from Plex.tv for authentication flows
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { PlexAPI } from "@lukehagar/plexjs";
|
|
|
|
async function run() {
|
|
const sdk = new PlexAPI();
|
|
|
|
const xPlexClientIdentifier = "<value>";
|
|
const strong = false;
|
|
|
|
const result = await sdk.plex.getPin(xPlexClientIdentifier, strong);
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `xPlexClientIdentifier` | *string* | :heavy_check_mark: | 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/> |
|
|
| `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/> |
|
|
| `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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetPinResponse](../../models/operations/getpinresponse.md)>**
|
|
### 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
|
|
|
|
```typescript
|
|
import { PlexAPI } from "@lukehagar/plexjs";
|
|
|
|
async function run() {
|
|
const sdk = new PlexAPI();
|
|
|
|
const pinID = "<value>";
|
|
const xPlexClientIdentifier = "<value>";
|
|
|
|
const result = await sdk.plex.getToken(pinID, xPlexClientIdentifier);
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
|
| `xPlexClientIdentifier` | *string* | :heavy_check_mark: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetTokenResponse](../../models/operations/gettokenresponse.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| --------------------------- | --------------------------- | --------------------------- |
|
|
| errors.GetTokenResponseBody | 400 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|