ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0

2025-12-06 12:37:46 +00:00 · 2024-01-24 00:32:49 +00:00
parent e044084015
commit 64a942a910
254 changed files with 2806 additions and 356 deletions
--- a/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx
+++ b/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx
@@ -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.
--- a/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx
+++ b/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx
@@ -34,6 +34,7 @@ if res.object is not None:
      "title2": "Recently Released",
      "viewGroup": "movie",
      "viewMode": 65592,
+      "mixedParents": true,
      "Metadata": []
    }
  }
--- a/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx
+++ b/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx
@@ -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
--- a/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx
+++ b/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx
@@ -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
--- a/content/pages/01-reference/python/resources/library/library.mdx
+++ b/content/pages/01-reference/python/resources/library/library.mdx
@@ -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 />

--- a/content/pages/01-reference/python/resources/library/search_library/_header.mdx
+++ b/content/pages/01-reference/python/resources/library/search_library/_header.mdx
@@ -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.
--- a/content/pages/01-reference/python/resources/library/search_library/_parameters.mdx
+++ b/content/pages/01-reference/python/resources/library/search_library/_parameters.mdx
@@ -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>
+
--- a/content/pages/01-reference/python/resources/library/search_library/_response.mdx
+++ b/content/pages/01-reference/python/resources/library/search_library/_response.mdx
@@ -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>
+
+
+
--- a/content/pages/01-reference/python/resources/library/search_library/_usage.mdx
+++ b/content/pages/01-reference/python/resources/library/search_library/_usage.mdx
@@ -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>
--- a/content/pages/01-reference/python/resources/library/search_library/search_library.mdx
+++ b/content/pages/01-reference/python/resources/library/search_library/search_library.mdx
@@ -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 */}
--- a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)
+res = s.playlists.add_playlist_contents(playlist_id=8700.88, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)

 if res.object is not None:
    # handle response
--- a/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.clear_playlist_contents(playlist_id=7781.57)
+res = s.playlists.clear_playlist_contents(playlist_id=8700.13)

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx
@@ -10,9 +10,9 @@ s = plex_api.PlexAPI(

 req = operations.CreatePlaylistRequest(
    title='string',
-    type=operations.Type.VIDEO,
+    type=operations.QueryParamType.VIDEO,
    smart=operations.Smart.ONE,
-    uri='http://velvety-spiderling.com',
+    uri='https://bite-sized-favorite.com',
 )

 res = s.playlists.create_playlist(req)
--- a/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.delete_playlist(playlist_id=202.18)
+res = s.playlists.delete_playlist(playlist_id=8326.2)

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.get_playlist(playlist_id=6481.72)
+res = s.playlists.get_playlist(playlist_id=3682.41)

 if res.object is not None:
    # handle response
--- a/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56)
+res = s.playlists.get_playlist_contents(playlist_id=7781.57, type=1403.5)

 if res.object is not None:
    # handle response
--- a/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx
+++ b/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string')
+res = s.playlists.update_playlist(playlist_id=9571.56, title='string', summary='string')

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx
+++ b/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.security.get_source_connection_information(source='provider://provider-identifier')
+res = s.security.get_source_connection_information(source='server://client-identifier')

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx
+++ b/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx
@@ -1,14 +1,14 @@
 {/* Autogenerated DO NOT EDIT  */}
-import QueryParamType from "/content/types/models/operations/query_param_type/python.mdx"
+import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/python.mdx"
 import Scope from "/content/types/models/operations/scope/python.mdx"
 import Collapsible from "/src/components/Collapsible";
 import Labels from "/src/lib/labels";

-##### `type` *{`operations.QueryParamType`}*
+##### `type` *{`operations.GetTransientTokenQueryParamType`}*
 `delegation` \- This is the only supported `type` parameter.

 <Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
-  <QueryParamType />
+  <GetTransientTokenQueryParamType />
 </Collapsible>

 ---
--- a/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx
+++ b/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.security.get_transient_token(type=operations.QueryParamType.DELEGATION, scope=operations.Scope.ALL)
+res = s.security.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx
+++ b/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx
@@ -9,7 +9,7 @@ s = plex_api.PlexAPI(
 )


-res = s.updater.apply_updates(tonight=operations.Tonight.ZERO, skip=operations.Skip.ONE)
+res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ZERO)

 if res.status_code == 200:
    # handle response
--- a/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx
+++ b/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx
@@ -9,16 +9,16 @@ s = plex_api.PlexAPI(
 )

 req = operations.GetTimelineRequest(
-    rating_key=6788.8,
+    rating_key=7206.33,
    key='<key>',
-    state=operations.State.PLAYING,
-    has_mde=7206.33,
-    time=6399.21,
-    duration=5820.2,
+    state=operations.State.PAUSED,
+    has_mde=5820.2,
+    time=1433.53,
+    duration=5373.73,
    context='string',
-    play_queue_item_id=1433.53,
-    play_back_time=5373.73,
-    row=9446.69,
+    play_queue_item_id=9446.69,
+    play_back_time=7586.16,
+    row=5218.48,
 )

 res = s.video.get_timeline(req)
--- a/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx
+++ b/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx
@@ -9,10 +9,10 @@ s = plex_api.PlexAPI(
 )

 req = operations.StartUniversalTranscodeRequest(
-    has_mde=8009.11,
-    path='/private',
-    media_index=5204.78,
-    part_index=7805.29,
+    has_mde=5204.78,
+    path='/usr/libexec',
+    media_index=6788.8,
+    part_index=1182.74,
    protocol='string',
 )