LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.308.1

Browse Source
This commit is contained in:
speakeasybot
2024-06-14 16:24:40 +00:00
parent f918b86b8c
commit b48aa356a7
709 changed files with 12120 additions and 10823 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/sdks/plex/README.md
View File

@@ -8,9 +8,52 @@ API Calls that perform operations directly against https://Plex.tv
### Available Operations
* [getHomeData](#gethomedata) - Get Plex Home Data
* [getPin](#getpin) - Get a Pin
* [getToken](#gettoken) - Get Access Token
## getHomeData
Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
### Example Usage
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman",
});
async function run() {
const result = await plexAPI.plex.getHomeData();
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `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. |
### Response
**Promise\<[models.GetHomeDataResponse](../../models/gethomedataresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| models.GetHomeDataPlexResponseBody | 401 | application/json |
| models.SDKError | 4xx-5xx | */* |
## getPin
Retrieve a Pin from Plex.tv for authentication flows
@@ -25,7 +68,7 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.plex.getPin(false, "Postman");
const result = await plexAPI.plex.getPin("Postman", false, "Postman");
// Handle the result
console.log(result)
@@ -38,6 +81,7 @@ run();
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `xPlexProduct` | *string* | :heavy_check_mark: | Product name of the application shown in the list of devices<br/> | [object Object] |
| `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. | |
@@ -47,13 +91,13 @@ run();
### Response
**Promise\<[operations.GetPinResponse](../../models/operations/getpinresponse.md)\>**
**Promise\<[models.GetPinResponse](../../models/getpinresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------- | ------------------------- | ------------------------- |
| errors.GetPinResponseBody | 400 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| models.GetPinPlexResponseBody | 400 | application/json |
| models.SDKError | 4xx-5xx | */* |
## getToken
@@ -91,10 +135,10 @@ run();
### Response
**Promise\<[operations.GetTokenResponse](../../models/operations/gettokenresponse.md)\>**
**Promise\<[models.GetTokenResponse](../../models/gettokenresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------- | --------------------------- | --------------------------- |
| errors.GetTokenResponseBody | 400 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| models.GetTokenPlexResponseBody | 400 | application/json |
| models.SDKError | 4xx-5xx | */* |