LukeParke/plexpy
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexpy.git synced 2025-12-09 20:57:44 +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:57:59 +00:00
parent e11c88055c
commit a788b6dc7f
94 changed files with 2157 additions and 1240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,6 +13,7 @@ API Calls interacting with Plex Media Server Libraries
* [get_libraries](#get_libraries) - Get All Libraries
* [get_library](#get_library) - Get Library Details
* [delete_library](#delete_library) - Delete Library Section
* [get_library_items](#get_library_items) - Get Library Items
* [refresh_library](#refresh_library) - Refresh Library
* [search_library](#search_library) - Search Library
* [get_metadata](#get_metadata) - Get Items Metadata
@@ -33,6 +34,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_file_hash(url='file://C:\Image.png&type=13', type=4462.17)
if res is not None:
@@ -74,6 +76,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_recently_added()
if res.object is not None:
@@ -113,6 +116,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_libraries()
if res.object is not None:
@@ -186,6 +190,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ZERO)
if res.object is not None:
@@ -226,6 +231,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.delete_library(section_id=1000)
if res is not None:
@@ -251,6 +257,68 @@ if res is not None:
| errors.DeleteLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## get_library_items
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
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='Postman',
)
res = s.library.get_library_items(section_id=1, tag=operations.Tag.GENRE)
if res.object is not None:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `section_id` | *int* | :heavy_check_mark: | the Id of the library to query | 1 |
| `tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
### Response
**[operations.GetLibraryItemsResponse](../../models/operations/getlibraryitemsresponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetLibraryItemsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## refresh_library
This endpoint Refreshes the library.
@@ -266,6 +334,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.refresh_library(section_id=934.16)
if res is not None:
@@ -324,6 +393,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.search_library(section_id=933505, type=operations.Type.FOUR)
if res.object is not None:
@@ -345,9 +415,10 @@ if res.object is not None:
**[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 | */* |
## get_metadata
@@ -364,6 +435,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_metadata(rating_key=8382.31)
if res.object is not None:
@@ -404,6 +476,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_metadata_children(rating_key=1539.14)
if res.object is not None:
@@ -444,6 +517,7 @@ s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.library.get_on_deck()
if res.object is not None: