ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0

This commit is contained in:
speakeasybot
2024-01-24 00:32:49 +00:00
parent e044084015
commit 64a942a910
254 changed files with 2806 additions and 356 deletions

View File

@@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k
- `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.

View File

@@ -34,6 +34,7 @@ if res.object is not None:
"title2": "Recently Released",
"viewGroup": "movie",
"viewMode": 65592,
"mixedParents": true,
"Metadata": []
}
}

View File

@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
)
res = s.library.get_metadata(rating_key=7917.25)
res = s.library.get_metadata(rating_key=5288.95)
if res.object is not None:
# handle response

View File

@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
)
res = s.library.get_metadata_children(rating_key=8121.69)
res = s.library.get_metadata_children(rating_key=4799.77)
if res.object is not None:
# handle response

View File

@@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx";
import DeleteLibrary from "./delete_library/delete_library.mdx";
import GetLibraryItems from "./get_library_items/get_library_items.mdx";
import RefreshLibrary from "./refresh_library/refresh_library.mdx";
import SearchLibrary from "./search_library/search_library.mdx";
import GetMetadata from "./get_metadata/get_metadata.mdx";
import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx";
import GetOnDeck from "./get_on_deck/get_on_deck.mdx";
@@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries
* [Delete Library](/python/library/delete_library) - Delete Library Section
* [Get Library Items](/python/library/get_library_items) - Get Library Items
* [Refresh Library](/python/library/refresh_library) - Refresh Library
* [Search Library](/python/library/search_library) - Search Library
* [Get Metadata](/python/library/get_metadata) - Get Items Metadata
* [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children
* [Get On Deck](/python/library/get_on_deck) - Get On Deck
@@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries
---
<RefreshLibrary />
---
<SearchLibrary />
---
<GetMetadata />

View File

@@ -0,0 +1,20 @@
## Search Library
Search for content within a specific section of the library.
### Types
Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls:
- **Type Object Attributes**:
- `type`: Metadata type (if standard Plex type).
- `title`: Title for this content type (e.g., "Movies").
- **Filter Objects**:
- Subset of the media query language.
- Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`.
- **Sort Objects**:
- Description of sort fields.
- Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`.
> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import Type from "/content/types/models/operations/type/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` *{`operations.Type`}*
Plex content type to search for
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Type />
</Collapsible>

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
import SearchLibraryResponse from "/content/types/models/operations/search_library_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.SearchLibraryResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<SearchLibraryResponse />
</Collapsible>

View File

@@ -0,0 +1,39 @@
<CH.Code>
```python SearchLibrary.py
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.library.search_library(section_id=791725, type=operations.Type.FOUR)
if res.object is not None:
# handle response
pass
```
---
```json Example Response
{
"MediaContainer": {
"size": 2,
"allowSync": false,
"art": "/:/resources/show-fanart.jpg",
"identifier": "com.plexapp.plugins.library",
"mediaTagPrefix": "/system/bundle/media/flags/",
"mediaTagVersion": 1698860922,
"nocache": true,
"thumb": "/:/resources/show.png",
"title1": "TV Shows",
"title2": "Search for ''",
"viewGroup": "season",
"viewMode": 65593,
"Metadata": []
}
}
```
</CH.Code>

View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Library*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}