mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-09 12:37:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0
This commit is contained in:
@@ -1,3 +1,23 @@
|
||||
## Get Library Items
|
||||
|
||||
This endpoint will return a list of library items filtered by the filter and type provided
|
||||
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.
|
||||
- `search?type=1`: Search functionality within the section.
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `section_id` *{`float`}*
|
||||
import Tag from "/content/types/models/operations/tag/python.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### `section_id` *{`int`}*
|
||||
the Id of the library to query
|
||||
|
||||
---
|
||||
##### `type` *{`Optional[float]`}*
|
||||
item type
|
||||
##### `tag` *{`operations.Tag`}*
|
||||
A key representing a specific tag within the section.
|
||||
|
||||
---
|
||||
##### `filter_` *{`Optional[str]`}*
|
||||
the filter parameter
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Tag />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
@@ -9,9 +9,9 @@ s = plex_api.PlexAPI(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_library_items(section_id=2726.56, type=3834.41, filter_='string')
|
||||
res = s.library.get_library_items(section_id=272656, tag=operations.Tag.EDITION)
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -19,13 +19,23 @@ if res.status_code == 200:
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
]
|
||||
"MediaContainer": {
|
||||
"size": 70,
|
||||
"allowSync": true,
|
||||
"art": "/:/resources/movie-fanart.jpg",
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1701731894,
|
||||
"thumb": "/:/resources/movie.png",
|
||||
"title1": "Movies",
|
||||
"title2": "Recently Released",
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"Metadata": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
|
||||
Reference in New Issue
Block a user