ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0

2025-12-09 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/go/resources/library/get_library_items/_header.mdx
+++ b/content/pages/01-reference/go/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/go/resources/library/get_library_items/_usage.mdx
+++ b/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx
@@ -51,6 +51,7 @@ func main() {
      "title2": "Recently Released",
      "viewGroup": "movie",
      "viewMode": 65592,
+      "mixedParents": true,
      "Metadata": []
    }
  }
--- a/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx
+++ b/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx
@@ -16,7 +16,7 @@ func main() {
    )


-    var ratingKey float64 = 7917.25
+    var ratingKey float64 = 5288.95

    ctx := context.Background()
    res, err := s.Library.GetMetadata(ctx, ratingKey)
--- a/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx
+++ b/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx
@@ -16,7 +16,7 @@ func main() {
    )


-    var ratingKey float64 = 8121.69
+    var ratingKey float64 = 4799.77

    ctx := context.Background()
    res, err := s.Library.GetMetadataChildren(ctx, ratingKey)
--- a/content/pages/01-reference/go/resources/library/library.mdx
+++ b/content/pages/01-reference/go/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](/go/library/delete_library) - Delete Library Section
 * [Get Library Items](/go/library/get_library_items) - Get Library Items
 * [Refresh Library](/go/library/refresh_library) - Refresh Library
+* [Search Library](/go/library/search_library) - Search Library
 * [Get Metadata](/go/library/get_metadata) - Get Items Metadata
 * [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children
 * [Get On Deck](/go/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/go/resources/library/search_library/_header.mdx
+++ b/content/pages/01-reference/go/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/go/resources/library/search_library/_parameters.mdx
+++ b/content/pages/01-reference/go/resources/library/search_library/_parameters.mdx
@@ -0,0 +1,20 @@
+{/* Autogenerated DO NOT EDIT  */}
+import Type from "/content/types/models/operations/type/go.mdx"
+import Collapsible from "/src/components/Collapsible";
+import Labels from "/src/lib/labels";
+
+##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
+The context to use for the request.
+
+---
+##### `sectionID` *{`int64`}*
+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/go/resources/library/search_library/_response.mdx
+++ b/content/pages/01-reference/go/resources/library/search_library/_response.mdx
@@ -0,0 +1,16 @@
+{/* Autogenerated DO NOT EDIT  */}
+import SearchLibraryResponse from "/content/types/models/operations/search_library_response/go.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>
+
+
+---
+##### *{`error`}*
+
+
--- a/content/pages/01-reference/go/resources/library/search_library/_usage.mdx
+++ b/content/pages/01-reference/go/resources/library/search_library/_usage.mdx
@@ -0,0 +1,56 @@
+
+<CH.Code>
+```go SearchLibrary.go
+package main
+
+import(
+	"github.com/LukeHagar/plexgo/models/components"
+	"github.com/LukeHagar/plexgo"
+	"github.com/LukeHagar/plexgo/models/operations"
+	"context"
+	"log"
+)
+
+func main() {
+    s := plexgo.New(
+        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
+    )
+
+
+    var sectionID int64 = 791725
+
+    var type_ operations.Type = operations.TypeFour
+
+    ctx := context.Background()
+    res, err := s.Library.SearchLibrary(ctx, sectionID, type_)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Object != nil {
+        // handle response
+    }
+}
+```
+---
+
+```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/go/resources/library/search_library/search_library.mdx
+++ b/content/pages/01-reference/go/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/go/resources/playlists/add_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx
@@ -16,7 +16,7 @@ func main() {
    )


-    var playlistID float64 = 1403.5
+    var playlistID float64 = 8700.88

    var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1"

--- a/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx
@@ -17,7 +17,7 @@ func main() {
    )


-    var playlistID float64 = 7781.57
+    var playlistID float64 = 8700.13

    ctx := context.Background()
    res, err := s.Playlists.ClearPlaylistContents(ctx, playlistID)
--- a/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx
@@ -19,9 +19,9 @@ func main() {
    ctx := context.Background()
    res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{
        Title: "string",
-        Type: operations.TypeVideo,
+        Type: operations.QueryParamTypeVideo,
        Smart: operations.SmartOne,
-        URI: "http://velvety-spiderling.com",
+        URI: "https://bite-sized-favorite.com",
    })
    if err != nil {
        log.Fatal(err)
--- a/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx
@@ -17,7 +17,7 @@ func main() {
    )


-    var playlistID float64 = 202.18
+    var playlistID float64 = 8326.2

    ctx := context.Background()
    res, err := s.Playlists.DeletePlaylist(ctx, playlistID)
--- a/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx
@@ -16,7 +16,7 @@ func main() {
    )


-    var playlistID float64 = 6481.72
+    var playlistID float64 = 3682.41

    ctx := context.Background()
    res, err := s.Playlists.GetPlaylist(ctx, playlistID)
--- a/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx
@@ -16,9 +16,9 @@ func main() {
    )


-    var playlistID float64 = 8326.2
+    var playlistID float64 = 7781.57

-    var type_ float64 = 9571.56
+    var type_ float64 = 1403.5

    ctx := context.Background()
    res, err := s.Playlists.GetPlaylistContents(ctx, playlistID, type_)
--- a/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx
+++ b/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx
@@ -17,7 +17,7 @@ func main() {
    )


-    var playlistID float64 = 3682.41
+    var playlistID float64 = 9571.56

    var title *string = "string"

--- a/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx
+++ b/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx
@@ -17,7 +17,7 @@ func main() {
    )


-    var source string = "provider://provider-identifier"
+    var source string = "server://client-identifier"

    ctx := context.Background()
    res, err := s.Security.GetSourceConnectionInformation(ctx, source)
--- a/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx
+++ b/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx
@@ -1,5 +1,5 @@
 {/* Autogenerated DO NOT EDIT  */}
-import QueryParamType from "/content/types/models/operations/query_param_type/go.mdx"
+import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/go.mdx"
 import Scope from "/content/types/models/operations/scope/go.mdx"
 import Collapsible from "/src/components/Collapsible";
 import Labels from "/src/lib/labels";
@@ -8,11 +8,11 @@ import Labels from "/src/lib/labels";
 The context to use for the request.

 ---
-##### `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/go/resources/security/get_transient_token/_usage.mdx
+++ b/content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx
@@ -18,7 +18,7 @@ func main() {
    )


-    var type_ operations.QueryParamType = operations.QueryParamTypeDelegation
+    var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation

    var scope operations.Scope = operations.ScopeAll

--- a/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx
+++ b/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx
@@ -18,9 +18,9 @@ func main() {
    )


-    var tonight *operations.Tonight = operations.TonightZero
+    var tonight *operations.Tonight = operations.TonightOne

-    var skip *operations.Skip = operations.SkipOne
+    var skip *operations.Skip = operations.SkipZero

    ctx := context.Background()
    res, err := s.Updater.ApplyUpdates(ctx, tonight, skip)
--- a/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx
+++ b/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx
@@ -19,16 +19,16 @@ func main() {

    ctx := context.Background()
    res, err := s.Video.GetTimeline(ctx, operations.GetTimelineRequest{
-        RatingKey: 6788.8,
+        RatingKey: 7206.33,
        Key: "<key>",
-        State: operations.StatePlaying,
-        HasMDE: 7206.33,
-        Time: 6399.21,
-        Duration: 5820.2,
+        State: operations.StatePaused,
+        HasMDE: 5820.2,
+        Time: 1433.53,
+        Duration: 5373.73,
        Context: "string",
-        PlayQueueItemID: 1433.53,
-        PlayBackTime: 5373.73,
-        Row: 9446.69,
+        PlayQueueItemID: 9446.69,
+        PlayBackTime: 7586.16,
+        Row: 5218.48,
    })
    if err != nil {
        log.Fatal(err)
--- a/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx
+++ b/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx
@@ -19,10 +19,10 @@ func main() {

    ctx := context.Background()
    res, err := s.Video.StartUniversalTranscode(ctx, operations.StartUniversalTranscodeRequest{
-        HasMDE: 8009.11,
-        Path: "/private",
-        MediaIndex: 5204.78,
-        PartIndex: 7805.29,
+        HasMDE: 5204.78,
+        Path: "/usr/libexec",
+        MediaIndex: 6788.8,
+        PartIndex: 1182.74,
        Protocol: "string",
    })
    if err != nil {