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.665.0

Browse Source
This commit is contained in:
speakeasybot
2025-12-01 01:50:09 +00:00
parent 956c980d8b
commit 4f27055ae6
1985 changed files with 24972 additions and 34528 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/sdks/updater/README.md
View File

@@ -22,7 +22,7 @@ Apply any downloaded updates. Note that the two parameters `tonight` and `skip`
<!-- UsageSnippet language="typescript" operationID="applyUpdates" method="put" path="/updater/apply" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts, BoolInt } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -40,12 +40,12 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.updater.applyUpdates({
await plexAPI.updater.applyUpdates({
tonight: BoolInt.True,
skip: BoolInt.True,
});
console.log(result);
}
run();
@@ -58,7 +58,7 @@ The standalone function version of this method:
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { updaterApplyUpdates } from "@lukehagar/plexjs/funcs/updaterApplyUpdates.js";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts, BoolInt } from "@lukehagar/plexjs/models/shared";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
@@ -84,7 +84,7 @@ async function run() {
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("updaterApplyUpdates failed:", res.error);
}
@@ -97,14 +97,14 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.ApplyUpdatesRequest](../../sdk/models/operations/applyupdatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `request` | [operations.ApplyUpdatesRequest](../../models/operations/applyupdatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `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.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.ApplyUpdatesResponse](../../sdk/models/operations/applyupdatesresponse.md)\>**
**Promise\<void\>**
### Errors
@@ -121,7 +121,7 @@ Perform an update check and potentially download
<!-- UsageSnippet language="typescript" operationID="checkUpdates" method="put" path="/updater/check" -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts, BoolInt } from "@lukehagar/plexjs/models/shared";
const plexAPI = new PlexAPI({
accepts: Accepts.ApplicationXml,
@@ -139,11 +139,11 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.updater.checkUpdates({
await plexAPI.updater.checkUpdates({
download: BoolInt.True,
});
console.log(result);
}
run();
@@ -156,7 +156,7 @@ The standalone function version of this method:
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { updaterCheckUpdates } from "@lukehagar/plexjs/funcs/updaterCheckUpdates.js";
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
import { Accepts, BoolInt } from "@lukehagar/plexjs/models/shared";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
@@ -181,7 +181,7 @@ async function run() {
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("updaterCheckUpdates failed:", res.error);
}
@@ -194,14 +194,14 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.CheckUpdatesRequest](../../sdk/models/operations/checkupdatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `request` | [operations.CheckUpdatesRequest](../../models/operations/checkupdatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `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.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.CheckUpdatesResponse](../../sdk/models/operations/checkupdatesresponse.md)\>**
**Promise\<void\>**
### Errors
@@ -269,7 +269,7 @@ run();
### Response
**Promise\<[operations.GetUpdatesStatusResponse](../../sdk/models/operations/getupdatesstatusresponse.md)\>**
**Promise\<[operations.GetUpdatesStatusResponse](../../models/operations/getupdatesstatusresponse.md)\>**
### Errors