mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.665.0
This commit is contained in:
speakeasybot
@@ -32,8 +32,8 @@ Note: Either `uri` or `playlistID` must be specified
|
||||
<!-- UsageSnippet language="typescript" operationID="createPlayQueue" method="post" path="/playQueues" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { CreatePlayQueueType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { CreatePlayQueueType } from "@lukehagar/plexjs/models/operations";
|
||||
import { Accepts, BoolInt } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -73,8 +73,8 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueCreatePlayQueue } from "@lukehagar/plexjs/funcs/playQueueCreatePlayQueue.js";
|
||||
import { CreatePlayQueueType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Accepts, BoolInt } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { CreatePlayQueueType } from "@lukehagar/plexjs/models/operations";
|
||||
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.
|
||||
@@ -117,14 +117,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.CreatePlayQueueRequest](../../sdk/models/operations/createplayqueuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.CreatePlayQueueRequest](../../models/operations/createplayqueuerequest.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.CreatePlayQueueResponse](../../sdk/models/operations/createplayqueueresponse.md)\>**
|
||||
**Promise\<[operations.CreatePlayQueueResponse](../../models/operations/createplayqueueresponse.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -141,7 +141,7 @@ Retrieves the play queue, centered at current item. This can be treated as a reg
|
||||
<!-- UsageSnippet language="typescript" operationID="getPlayQueue" method="get" path="/playQueues/{playQueueId}" -->
|
||||
```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,
|
||||
@@ -179,7 +179,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueGetPlayQueue } from "@lukehagar/plexjs/funcs/playQueueGetPlayQueue.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.
|
||||
@@ -220,14 +220,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetPlayQueueRequest](../../sdk/models/operations/getplayqueuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetPlayQueueRequest](../../models/operations/getplayqueuerequest.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.GetPlayQueueResponse](../../sdk/models/operations/getplayqueueresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -244,7 +244,7 @@ Adds an item to a play queue (e.g. party mode). Increments the version of the pl
|
||||
<!-- UsageSnippet language="typescript" operationID="addToPlayQueue" method="put" path="/playQueues/{playQueueId}" -->
|
||||
```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,
|
||||
@@ -280,7 +280,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueAddToPlayQueue } from "@lukehagar/plexjs/funcs/playQueueAddToPlayQueue.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.
|
||||
@@ -319,14 +319,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.AddToPlayQueueRequest](../../sdk/models/operations/addtoplayqueuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.AddToPlayQueueRequest](../../models/operations/addtoplayqueuerequest.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.AddToPlayQueueResponse](../../sdk/models/operations/addtoplayqueueresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -343,7 +343,7 @@ Deletes all items in the play queue, and increases the version of the play queue
|
||||
<!-- UsageSnippet language="typescript" operationID="clearPlayQueue" method="delete" path="/playQueues/{playQueueId}/items" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -378,7 +378,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueClearPlayQueue } from "@lukehagar/plexjs/funcs/playQueueClearPlayQueue.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -416,14 +416,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.ClearPlayQueueRequest](../../sdk/models/operations/clearplayqueuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.ClearPlayQueueRequest](../../models/operations/clearplayqueuerequest.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.ClearPlayQueueResponse](../../sdk/models/operations/clearplayqueueresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -440,7 +440,7 @@ Reset a play queue to the first item being the current item
|
||||
<!-- UsageSnippet language="typescript" operationID="resetPlayQueue" method="put" path="/playQueues/{playQueueId}/reset" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -475,7 +475,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueResetPlayQueue } from "@lukehagar/plexjs/funcs/playQueueResetPlayQueue.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -513,14 +513,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.ResetPlayQueueRequest](../../sdk/models/operations/resetplayqueuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.ResetPlayQueueRequest](../../models/operations/resetplayqueuerequest.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.ResetPlayQueueResponse](../../sdk/models/operations/resetplayqueueresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -537,7 +537,7 @@ Shuffle a play queue (or reshuffles if already shuffled). The currently selected
|
||||
<!-- UsageSnippet language="typescript" operationID="shuffle" method="put" path="/playQueues/{playQueueId}/shuffle" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -572,7 +572,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueShuffle } from "@lukehagar/plexjs/funcs/playQueueShuffle.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -610,14 +610,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.ShuffleRequest](../../sdk/models/operations/shufflerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.ShuffleRequest](../../models/operations/shufflerequest.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.ShuffleResponse](../../sdk/models/operations/shuffleresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -634,7 +634,7 @@ Unshuffles a play queue and restores "natural order". Note that this is currentl
|
||||
<!-- UsageSnippet language="typescript" operationID="unshuffle" method="put" path="/playQueues/{playQueueId}/unshuffle" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -669,7 +669,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueUnshuffle } from "@lukehagar/plexjs/funcs/playQueueUnshuffle.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -707,14 +707,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.UnshuffleRequest](../../sdk/models/operations/unshufflerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.UnshuffleRequest](../../models/operations/unshufflerequest.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.UnshuffleResponse](../../sdk/models/operations/unshuffleresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -731,7 +731,7 @@ Deletes an item in a play queue. Increments the version of the play queue. Retur
|
||||
<!-- UsageSnippet language="typescript" operationID="deletePlayQueueItem" method="delete" path="/playQueues/{playQueueId}/items/{playQueueItemId}" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -767,7 +767,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueDeletePlayQueueItem } from "@lukehagar/plexjs/funcs/playQueueDeletePlayQueueItem.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -806,14 +806,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.DeletePlayQueueItemRequest](../../sdk/models/operations/deleteplayqueueitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.DeletePlayQueueItemRequest](../../models/operations/deleteplayqueueitemrequest.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.DeletePlayQueueItemResponse](../../sdk/models/operations/deleteplayqueueitemresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
@@ -830,7 +830,7 @@ Moves an item in a play queue, and increases the version of the play queue. Retu
|
||||
<!-- UsageSnippet language="typescript" operationID="movePlayQueueItem" method="put" path="/playQueues/{playQueueId}/items/{playQueueItemId}/move" -->
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accepts: Accepts.ApplicationXml,
|
||||
@@ -866,7 +866,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { playQueueMovePlayQueueItem } from "@lukehagar/plexjs/funcs/playQueueMovePlayQueueItem.js";
|
||||
import { Accepts } from "@lukehagar/plexjs/sdk/models/shared";
|
||||
import { Accepts } from "@lukehagar/plexjs/models/shared";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -905,14 +905,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.MovePlayQueueItemRequest](../../sdk/models/operations/moveplayqueueitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.MovePlayQueueItemRequest](../../models/operations/moveplayqueueitemrequest.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.MovePlayQueueItemResponse](../../sdk/models/operations/moveplayqueueitemresponse.md)\>**
|
||||
**Promise\<[shared.MediaContainerWithPlaylistMetadata](../../models/shared/mediacontainerwithplaylistmetadata.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
|
||||
Reference in New Issue
Block a user