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

Normalized imports, regenerated

Browse Source
This commit is contained in:
Luke Hagar
2024-09-08 03:06:14 +00:00
parent 4d8ee6c199
commit 244adab882
1008 changed files with 21410 additions and 19981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/sdk/models/operations/getwatchlistrequest.md Normal file
View File

@@ -0,0 +1,28 @@
# GetWatchListRequest
## Example Usage
```typescript
import { Filter, GetWatchListRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetWatchListRequest = {
filter: Filter.Available,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | [operations.Filter](../../../sdk/models/operations/filter.md) | :heavy_check_mark: | Filter | |
| `sort` | *string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | |
| `libtype` | [operations.Libtype](../../../sdk/models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | |
| `maxresults` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | |
| `includeCollections` | [operations.IncludeCollections](../../../sdk/models/operations/includecollections.md) | :heavy_minus_sign: | include collections in the results<br/> | |
| `includeExternalMedia` | [operations.IncludeExternalMedia](../../../sdk/models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |