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

Browse Source
This commit is contained in:
speakeasybot
2024-05-23 15:59:09 +00:00
parent e418c55013
commit ddc4f916f2
219 changed files with 4677 additions and 6705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/sdks/activities/README.md
View File

@@ -51,7 +51,7 @@ run();
### Response
**Promise<[operations.GetServerActivitiesResponse](../../models/operations/getserveractivitiesresponse.md)>**
**Promise\<[operations.GetServerActivitiesResponse](../../models/operations/getserveractivitiesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -94,7 +94,7 @@ run();
### Response
**Promise<[operations.CancelServerActivitiesResponse](../../models/operations/cancelserveractivitiesresponse.md)>**
**Promise\<[operations.CancelServerActivitiesResponse](../../models/operations/cancelserveractivitiesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

4
docs/sdks/authentication/README.md
View File

@@ -49,7 +49,7 @@ run();
### Response
**Promise<[operations.GetTransientTokenResponse](../../models/operations/gettransienttokenresponse.md)>**
**Promise\<[operations.GetTransientTokenResponse](../../models/operations/gettransienttokenresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -94,7 +94,7 @@ run();
### Response
**Promise<[operations.GetSourceConnectionInformationResponse](../../models/operations/getsourceconnectioninformationresponse.md)>**
**Promise\<[operations.GetSourceConnectionInformationResponse](../../models/operations/getsourceconnectioninformationresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

10
docs/sdks/butler/README.md
View File

@@ -48,7 +48,7 @@ run();
### Response
**Promise<[operations.GetButlerTasksResponse](../../models/operations/getbutlertasksresponse.md)>**
**Promise\<[operations.GetButlerTasksResponse](../../models/operations/getbutlertasksresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -95,7 +95,7 @@ run();
### Response
**Promise<[operations.StartAllTasksResponse](../../models/operations/startalltasksresponse.md)>**
**Promise\<[operations.StartAllTasksResponse](../../models/operations/startalltasksresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -138,7 +138,7 @@ run();
### Response
**Promise<[operations.StopAllTasksResponse](../../models/operations/stopalltasksresponse.md)>**
**Promise\<[operations.StopAllTasksResponse](../../models/operations/stopalltasksresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -187,7 +187,7 @@ run();
### Response
**Promise<[operations.StartTaskResponse](../../models/operations/starttaskresponse.md)>**
**Promise\<[operations.StartTaskResponse](../../models/operations/starttaskresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -232,7 +232,7 @@ run();
### Response
**Promise<[operations.StopTaskResponse](../../models/operations/stoptaskresponse.md)>**
**Promise\<[operations.StopTaskResponse](../../models/operations/stoptaskresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

4
docs/sdks/hubs/README.md
View File

@@ -48,7 +48,7 @@ run();
### Response
**Promise<[operations.GetGlobalHubsResponse](../../models/operations/getglobalhubsresponse.md)>**
**Promise\<[operations.GetGlobalHubsResponse](../../models/operations/getglobalhubsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -95,7 +95,7 @@ run();
### Response
**Promise<[operations.GetLibraryHubsResponse](../../models/operations/getlibraryhubsresponse.md)>**
**Promise\<[operations.GetLibraryHubsResponse](../../models/operations/getlibraryhubsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

93
docs/sdks/library/README.md
View File

@@ -13,6 +13,7 @@ API Calls interacting with Plex Media Server Libraries
* [getLibraries](#getlibraries) - Get All Libraries
* [getLibrary](#getlibrary) - Get Library Details
* [deleteLibrary](#deletelibrary) - Delete Library Section
* [getLibraryItems](#getlibraryitems) - Get Library Items
* [refreshLibrary](#refreshlibrary) - Refresh Library
* [searchLibrary](#searchlibrary) - Search Library
* [getMetadata](#getmetadata) - Get Items Metadata
@@ -55,7 +56,7 @@ run();
### Response
**Promise<[operations.GetFileHashResponse](../../models/operations/getfilehashresponse.md)>**
**Promise\<[operations.GetFileHashResponse](../../models/operations/getfilehashresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -98,7 +99,7 @@ run();
### Response
**Promise<[operations.GetRecentlyAddedResponse](../../models/operations/getrecentlyaddedresponse.md)>**
**Promise\<[operations.GetRecentlyAddedResponse](../../models/operations/getrecentlyaddedresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -146,7 +147,7 @@ run();
### Response
**Promise<[operations.GetLibrariesResponse](../../models/operations/getlibrariesresponse.md)>**
**Promise\<[operations.GetLibrariesResponse](../../models/operations/getlibrariesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -230,7 +231,7 @@ run();
### Response
**Promise<[operations.GetLibraryResponse](../../models/operations/getlibraryresponse.md)>**
**Promise\<[operations.GetLibraryResponse](../../models/operations/getlibraryresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -273,7 +274,7 @@ run();
### Response
**Promise<[operations.DeleteLibraryResponse](../../models/operations/deletelibraryresponse.md)>**
**Promise\<[operations.DeleteLibraryResponse](../../models/operations/deletelibraryresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -281,6 +282,71 @@ run();
| errors.DeleteLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getLibraryItems
Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
- `all`: All items in the section.
- `unwatched`: Items that have not been played.
- `newest`: Items that are recently released.
- `recentlyAdded`: Items that are recently added to the library.
- `recentlyViewed`: Items that were recently viewed.
- `onDeck`: Items to continue watching.
- `collection`: Items categorized by collection.
- `edition`: Items categorized by edition.
- `genre`: Items categorized by genre.
- `year`: Items categorized by year of release.
- `decade`: Items categorized by decade.
- `director`: Items categorized by director.
- `actor`: Items categorized by starring actor.
- `country`: Items categorized by country of origin.
- `contentRating`: Items categorized by content rating.
- `rating`: Items categorized by rating.
- `resolution`: Items categorized by resolution.
- `firstCharacter`: Items categorized by the first letter.
- `folder`: Items categorized by folder.
### Example Usage
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { Tag } from "@lukehagar/plexjs/models/operations";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman",
});
async function run() {
const result = await plexAPI.library.getLibraryItems(1, Tag.Genre);
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | [object Object] |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `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\<[operations.GetLibraryItemsResponse](../../models/operations/getlibraryitemsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetLibraryItemsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## refreshLibrary
This endpoint Refreshes the library.
@@ -317,7 +383,7 @@ run();
### Response
**Promise<[operations.RefreshLibraryResponse](../../models/operations/refreshlibraryresponse.md)>**
**Promise\<[operations.RefreshLibraryResponse](../../models/operations/refreshlibraryresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -380,12 +446,13 @@ run();
### Response
**Promise<[operations.SearchLibraryResponse](../../models/operations/searchlibraryresponse.md)>**
**Promise\<[operations.SearchLibraryResponse](../../models/operations/searchlibraryresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.SearchLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getMetadata
@@ -423,7 +490,7 @@ run();
### Response
**Promise<[operations.GetMetadataResponse](../../models/operations/getmetadataresponse.md)>**
**Promise\<[operations.GetMetadataResponse](../../models/operations/getmetadataresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -467,7 +534,7 @@ run();
### Response
**Promise<[operations.GetMetadataChildrenResponse](../../models/operations/getmetadatachildrenresponse.md)>**
**Promise\<[operations.GetMetadataChildrenResponse](../../models/operations/getmetadatachildrenresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -510,7 +577,7 @@ run();
### Response
**Promise<[operations.GetOnDeckResponse](../../models/operations/getondeckresponse.md)>**
**Promise\<[operations.GetOnDeckResponse](../../models/operations/getondeckresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

6
docs/sdks/log/README.md
View File

@@ -51,7 +51,7 @@ run();
### Response
**Promise<[operations.LogLineResponse](../../models/operations/loglineresponse.md)>**
**Promise\<[operations.LogLineResponse](../../models/operations/loglineresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -117,7 +117,7 @@ run();
### Response
**Promise<[operations.LogMultiLineResponse](../../models/operations/logmultilineresponse.md)>**
**Promise\<[operations.LogMultiLineResponse](../../models/operations/logmultilineresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -160,7 +160,7 @@ run();
### Response
**Promise<[operations.EnablePaperTrailResponse](../../models/operations/enablepapertrailresponse.md)>**
**Promise\<[operations.EnablePaperTrailResponse](../../models/operations/enablepapertrailresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

6
docs/sdks/media/README.md
View File

@@ -47,7 +47,7 @@ run();
### Response
**Promise<[operations.MarkPlayedResponse](../../models/operations/markplayedresponse.md)>**
**Promise\<[operations.MarkPlayedResponse](../../models/operations/markplayedresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -90,7 +90,7 @@ run();
### Response
**Promise<[operations.MarkUnplayedResponse](../../models/operations/markunplayedresponse.md)>**
**Promise\<[operations.MarkUnplayedResponse](../../models/operations/markunplayedresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -136,7 +136,7 @@ run();
### Response
**Promise<[operations.UpdatePlayProgressResponse](../../models/operations/updateplayprogressresponse.md)>**
**Promise\<[operations.UpdatePlayProgressResponse](../../models/operations/updateplayprogressresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

18
docs/sdks/playlists/README.md
View File

@@ -65,7 +65,7 @@ run();
### Response
**Promise<[operations.CreatePlaylistResponse](../../models/operations/createplaylistresponse.md)>**
**Promise\<[operations.CreatePlaylistResponse](../../models/operations/createplaylistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -110,7 +110,7 @@ run();
### Response
**Promise<[operations.GetPlaylistsResponse](../../models/operations/getplaylistsresponse.md)>**
**Promise\<[operations.GetPlaylistsResponse](../../models/operations/getplaylistsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -155,7 +155,7 @@ run();
### Response
**Promise<[operations.GetPlaylistResponse](../../models/operations/getplaylistresponse.md)>**
**Promise\<[operations.GetPlaylistResponse](../../models/operations/getplaylistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -199,7 +199,7 @@ run();
### Response
**Promise<[operations.DeletePlaylistResponse](../../models/operations/deleteplaylistresponse.md)>**
**Promise\<[operations.DeletePlaylistResponse](../../models/operations/deleteplaylistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -245,7 +245,7 @@ run();
### Response
**Promise<[operations.UpdatePlaylistResponse](../../models/operations/updateplaylistresponse.md)>**
**Promise\<[operations.UpdatePlaylistResponse](../../models/operations/updateplaylistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -293,7 +293,7 @@ run();
### Response
**Promise<[operations.GetPlaylistContentsResponse](../../models/operations/getplaylistcontentsresponse.md)>**
**Promise\<[operations.GetPlaylistContentsResponse](../../models/operations/getplaylistcontentsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -337,7 +337,7 @@ run();
### Response
**Promise<[operations.ClearPlaylistContentsResponse](../../models/operations/clearplaylistcontentsresponse.md)>**
**Promise\<[operations.ClearPlaylistContentsResponse](../../models/operations/clearplaylistcontentsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -384,7 +384,7 @@ run();
### Response
**Promise<[operations.AddPlaylistContentsResponse](../../models/operations/addplaylistcontentsresponse.md)>**
**Promise\<[operations.AddPlaylistContentsResponse](../../models/operations/addplaylistcontentsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -430,7 +430,7 @@ run();
### Response
**Promise<[operations.UploadPlaylistResponse](../../models/operations/uploadplaylistresponse.md)>**
**Promise\<[operations.UploadPlaylistResponse](../../models/operations/uploadplaylistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -47,7 +47,7 @@ run();
### Response
**Promise<[operations.GetPinResponse](../../models/operations/getpinresponse.md)>**
**Promise\<[operations.GetPinResponse](../../models/operations/getpinresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -91,7 +91,7 @@ run();
### Response
**Promise<[operations.GetTokenResponse](../../models/operations/gettokenresponse.md)>**
**Promise\<[operations.GetTokenResponse](../../models/operations/gettokenresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

6
docs/sdks/search/README.md
View File

@@ -61,7 +61,7 @@ run();
### Response
**Promise<[operations.PerformSearchResponse](../../models/operations/performsearchresponse.md)>**
**Promise\<[operations.PerformSearchResponse](../../models/operations/performsearchresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -110,7 +110,7 @@ run();
### Response
**Promise<[operations.PerformVoiceSearchResponse](../../models/operations/performvoicesearchresponse.md)>**
**Promise\<[operations.PerformVoiceSearchResponse](../../models/operations/performvoicesearchresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -153,7 +153,7 @@ run();
### Response
**Promise<[operations.GetSearchResultsResponse](../../models/operations/getsearchresultsresponse.md)>**
**Promise\<[operations.GetSearchResultsResponse](../../models/operations/getsearchresultsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

16
docs/sdks/server/README.md
View File

@@ -51,7 +51,7 @@ run();
### Response
**Promise<[operations.GetServerCapabilitiesResponse](../../models/operations/getservercapabilitiesresponse.md)>**
**Promise\<[operations.GetServerCapabilitiesResponse](../../models/operations/getservercapabilitiesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -93,7 +93,7 @@ run();
### Response
**Promise<[operations.GetServerPreferencesResponse](../../models/operations/getserverpreferencesresponse.md)>**
**Promise\<[operations.GetServerPreferencesResponse](../../models/operations/getserverpreferencesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -135,7 +135,7 @@ run();
### Response
**Promise<[operations.GetAvailableClientsResponse](../../models/operations/getavailableclientsresponse.md)>**
**Promise\<[operations.GetAvailableClientsResponse](../../models/operations/getavailableclientsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -177,7 +177,7 @@ run();
### Response
**Promise<[operations.GetDevicesResponse](../../models/operations/getdevicesresponse.md)>**
**Promise\<[operations.GetDevicesResponse](../../models/operations/getdevicesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -219,7 +219,7 @@ run();
### Response
**Promise<[operations.GetServerIdentityResponse](../../models/operations/getserveridentityresponse.md)>**
**Promise\<[operations.GetServerIdentityResponse](../../models/operations/getserveridentityresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -261,7 +261,7 @@ run();
### Response
**Promise<[operations.GetMyPlexAccountResponse](../../models/operations/getmyplexaccountresponse.md)>**
**Promise\<[operations.GetMyPlexAccountResponse](../../models/operations/getmyplexaccountresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -314,7 +314,7 @@ run();
### Response
**Promise<[operations.GetResizedPhotoResponse](../../models/operations/getresizedphotoresponse.md)>**
**Promise\<[operations.GetResizedPhotoResponse](../../models/operations/getresizedphotoresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -356,7 +356,7 @@ run();
### Response
**Promise<[operations.GetServerListResponse](../../models/operations/getserverlistresponse.md)>**
**Promise\<[operations.GetServerListResponse](../../models/operations/getserverlistresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

8
docs/sdks/sessions/README.md
View File

@@ -47,7 +47,7 @@ run();
### Response
**Promise<[operations.GetSessionsResponse](../../models/operations/getsessionsresponse.md)>**
**Promise\<[operations.GetSessionsResponse](../../models/operations/getsessionsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -89,7 +89,7 @@ run();
### Response
**Promise<[operations.GetSessionHistoryResponse](../../models/operations/getsessionhistoryresponse.md)>**
**Promise\<[operations.GetSessionHistoryResponse](../../models/operations/getsessionhistoryresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -131,7 +131,7 @@ run();
### Response
**Promise<[operations.GetTranscodeSessionsResponse](../../models/operations/gettranscodesessionsresponse.md)>**
**Promise\<[operations.GetTranscodeSessionsResponse](../../models/operations/gettranscodesessionsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -174,7 +174,7 @@ run();
### Response
**Promise<[operations.StopTranscodeSessionResponse](../../models/operations/stoptranscodesessionresponse.md)>**
**Promise\<[operations.StopTranscodeSessionResponse](../../models/operations/stoptranscodesessionresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

2
docs/sdks/statistics/README.md
View File

@@ -45,7 +45,7 @@ run();
### Response
**Promise<[operations.GetStatisticsResponse](../../models/operations/getstatisticsresponse.md)>**
**Promise\<[operations.GetStatisticsResponse](../../models/operations/getstatisticsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

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

@@ -47,7 +47,7 @@ run();
### Response
**Promise<[operations.GetUpdateStatusResponse](../../models/operations/getupdatestatusresponse.md)>**
**Promise\<[operations.GetUpdateStatusResponse](../../models/operations/getupdatestatusresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -91,7 +91,7 @@ run();
### Response
**Promise<[operations.CheckForUpdatesResponse](../../models/operations/checkforupdatesresponse.md)>**
**Promise\<[operations.CheckForUpdatesResponse](../../models/operations/checkforupdatesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -137,7 +137,7 @@ run();
### Response
**Promise<[operations.ApplyUpdatesResponse](../../models/operations/applyupdatesresponse.md)>**
**Promise\<[operations.ApplyUpdatesResponse](../../models/operations/applyupdatesresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |

4
docs/sdks/video/README.md
View File

@@ -58,7 +58,7 @@ run();
### Response
**Promise<[operations.GetTimelineResponse](../../models/operations/gettimelineresponse.md)>**
**Promise\<[operations.GetTimelineResponse](../../models/operations/gettimelineresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
@@ -118,7 +118,7 @@ run();
### Response
**Promise<[operations.StartUniversalTranscodeResponse](../../models/operations/startuniversaltranscoderesponse.md)>**
**Promise\<[operations.StartUniversalTranscodeResponse](../../models/operations/startuniversaltranscoderesponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |