ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.598.0

2025-12-06 04:20:46 +00:00 · 2025-08-06 00:13:08 +00:00
parent 82e9da0574
commit 5848325f97
25 changed files with 389 additions and 27 deletions
--- a/docs/sdks/activities/README.md
+++ b/docs/sdks/activities/README.md
@@ -23,6 +23,7 @@ Get Server Activities

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getServerActivities" method="get" path="/activities" -->
 ```go
 package main

@@ -74,6 +75,7 @@ Cancel Server Activities

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="cancelServerActivities" method="delete" path="/activities/{activityUUID}" -->
 ```go
 package main

--- a/docs/sdks/authentication/README.md
+++ b/docs/sdks/authentication/README.md
@@ -20,6 +20,7 @@ This endpoint provides the caller with a temporary token with the same access le

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTransientToken" method="get" path="/security/token" -->
 ```go
 package main

@@ -76,6 +77,7 @@ Note: requires Plex Media Server >= 1.15.4.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getSourceConnectionInformation" method="get" path="/security/resources" -->
 ```go
 package main

@@ -128,6 +130,7 @@ Get the User data from the provided X-Plex-Token

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTokenDetails" method="get" path="/user" -->
 ```go
 package main

@@ -179,6 +182,7 @@ Sign in user with username and password and return user data with Plex authentic

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="post-users-sign-in-data" method="post" path="/users/signin" -->
 ```go
 package main

--- a/docs/sdks/butler/README.md
+++ b/docs/sdks/butler/README.md
@@ -20,6 +20,7 @@ Returns a list of butler tasks

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getButlerTasks" method="get" path="/butler" -->
 ```go
 package main

@@ -76,6 +77,7 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="startAllTasks" method="post" path="/butler" -->
 ```go
 package main

@@ -128,6 +130,7 @@ This endpoint will stop all currently running tasks and remove any scheduled tas

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="stopAllTasks" method="delete" path="/butler" -->
 ```go
 package main

@@ -184,6 +187,7 @@ This endpoint will attempt to start a single Butler task that is enabled in the

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="startTask" method="post" path="/butler/{taskName}" -->
 ```go
 package main

@@ -238,6 +242,7 @@ This endpoint will stop a currently running task by name, or remove it from the

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="stopTask" method="delete" path="/butler/{taskName}" -->
 ```go
 package main

--- a/docs/sdks/hubs/README.md
+++ b/docs/sdks/hubs/README.md
@@ -18,6 +18,7 @@ Get Global Hubs filtered by the parameters provided.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getGlobalHubs" method="get" path="/hubs" -->
 ```go
 package main

@@ -72,6 +73,7 @@ This endpoint will return the recently added content.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-recently-added" method="get" path="/hubs/home/recentlyAdded" -->
 ```go
 package main

@@ -129,6 +131,7 @@ This endpoint will return a list of library specific hubs

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getLibraryHubs" method="get" path="/hubs/sections/{sectionId}" -->
 ```go
 package main

--- a/docs/sdks/library/README.md
+++ b/docs/sdks/library/README.md
@@ -35,6 +35,7 @@ This resource returns hash values for local files

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getFileHash" method="get" path="/library/hashes" -->
 ```go
 package main

@@ -51,7 +52,7 @@ func main() {
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

-    res, err := s.Library.GetFileHash(ctx, "file://C:\Image.png&type=13", nil)
+    res, err := s.Library.GetFileHash(ctx, "file://C:\\Image.png&type=13", nil)
    if err != nil {
        log.Fatal(err)
    }
@@ -89,6 +90,7 @@ This endpoint will return the recently added content.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-recently-added-library" method="get" path="/library/recentlyAdded" -->
 ```go
 package main

@@ -167,6 +169,7 @@ This allows a client to provide a rich interface around the media (e.g. allow so

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-all-libraries" method="get" path="/library/sections" -->
 ```go
 package main

@@ -257,6 +260,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-library-details" method="get" path="/library/sections/{sectionKey}" -->
 ```go
 package main

@@ -311,6 +315,7 @@ Delete a library using a specific section id

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="deleteLibrary" method="delete" path="/library/sections/{sectionKey}" -->
 ```go
 package main

@@ -384,6 +389,7 @@ Fetches details from a specific section of the library identified by a section k

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-library-items" method="get" path="/library/sections/{sectionKey}/{tag}" -->
 ```go
 package main

@@ -444,6 +450,7 @@ Retrieves a list of all general media data for this library.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-library-sections-all" method="get" path="/library/sections/{sectionKey}/all" -->
 ```go
 package main

@@ -506,6 +513,7 @@ This endpoint Refreshes all the Metadata of the library.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-refresh-library-metadata" method="get" path="/library/sections/{sectionKey}/refresh" -->
 ```go
 package main

@@ -578,6 +586,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-search-library" method="get" path="/library/sections/{sectionKey}/search" -->
 ```go
 package main

@@ -633,6 +642,7 @@ Retrieves a list of all the genres that are found for the media in this library.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-genres-library" method="get" path="/library/sections/{sectionKey}/genre" -->
 ```go
 package main

@@ -688,6 +698,7 @@ Retrieves a list of all the countries that are found for the media in this libra

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-countries-library" method="get" path="/library/sections/{sectionKey}/country" -->
 ```go
 package main

@@ -743,6 +754,7 @@ Retrieves a list of all the actors that are found for the media in this library.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-actors-library" method="get" path="/library/sections/{sectionKey}/actor" -->
 ```go
 package main

@@ -798,6 +810,7 @@ Search the provided query across all library sections, or a single section, and

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-search-all-libraries" method="get" path="/library/search" -->
 ```go
 package main

@@ -861,6 +874,7 @@ Multiple rating keys can be provided as a comma-separated list (e.g., "21119,216

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-media-meta-data" method="get" path="/library/metadata/{ratingKey}" -->
 ```go
 package main

@@ -929,6 +943,7 @@ Returns the background artwork for a library item.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-media-arts" method="get" path="/library/metadata/{ratingKey}/arts" -->
 ```go
 package main

@@ -979,6 +994,7 @@ Uploads an image to use as the background artwork for a library item, either fro

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="post-media-arts" method="post" path="/library/metadata/{ratingKey}/arts" -->
 ```go
 package main

@@ -1031,6 +1047,7 @@ Returns the available posters for a library item.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-media-posters" method="get" path="/library/metadata/{ratingKey}/posters" -->
 ```go
 package main

@@ -1081,6 +1098,7 @@ Uploads a poster to a library item, either from a local file or a remote URL

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="post-media-poster" method="post" path="/library/metadata/{ratingKey}/posters" -->
 ```go
 package main

@@ -1134,6 +1152,7 @@ This endpoint will return the children of of a library item specified with the r

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getMetadataChildren" method="get" path="/library/metadata/{ratingKey}/children" -->
 ```go
 package main

@@ -1188,6 +1207,7 @@ This endpoint will return the top watched content from libraries of a certain ty

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTopWatchedContent" method="get" path="/library/all/top" -->
 ```go
 package main

--- a/docs/sdks/log/README.md
+++ b/docs/sdks/log/README.md
@@ -19,6 +19,7 @@ This endpoint will write a single-line log message, including a level and source

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="logLine" method="get" path="/log" -->
 ```go
 package main

@@ -95,6 +96,7 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="logMultiLine" method="post" path="/log" -->
 ```go
 package main

@@ -150,6 +152,7 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="enablePaperTrail" method="get" path="/log/networked" -->
 ```go
 package main

--- a/docs/sdks/media/README.md
+++ b/docs/sdks/media/README.md
@@ -20,6 +20,7 @@ This will mark the provided media key as Played.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="markPlayed" method="get" path="/:/scrobble" -->
 ```go
 package main

@@ -72,6 +73,7 @@ This will mark the provided media key as Unplayed.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="markUnplayed" method="get" path="/:/unscrobble" -->
 ```go
 package main

@@ -125,6 +127,7 @@ This API command can be used to update the play progress of a media item.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="updatePlayProgress" method="post" path="/:/progress" -->
 ```go
 package main

@@ -179,6 +182,7 @@ Gets the banner image of the media item

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-banner-image" method="get" path="/library/metadata/{ratingKey}/banner" -->
 ```go
 package main

@@ -239,6 +243,7 @@ Gets the thumbnail image of the media item

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-thumb-image" method="get" path="/library/metadata/{ratingKey}/thumb" -->
 ```go
 package main

--- a/docs/sdks/playlists/README.md
+++ b/docs/sdks/playlists/README.md
@@ -30,6 +30,7 @@ Create a new playlist. By default the playlist is blank. To create a playlist al

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="createPlaylist" method="post" path="/playlists" -->
 ```go
 package main

@@ -88,6 +89,7 @@ Get All Playlists given the specified filters.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getPlaylists" method="get" path="/playlists" -->
 ```go
 package main

@@ -143,6 +145,7 @@ Smart playlist details contain the `content` attribute. This is the content URI

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getPlaylist" method="get" path="/playlists/{playlistID}" -->
 ```go
 package main

@@ -196,6 +199,7 @@ This endpoint will delete a playlist

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="deletePlaylist" method="delete" path="/playlists/{playlistID}" -->
 ```go
 package main

@@ -249,6 +253,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="updatePlaylist" method="put" path="/playlists/{playlistID}" -->
 ```go
 package main

@@ -307,6 +312,7 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getPlaylistContents" method="get" path="/playlists/{playlistID}/items" -->
 ```go
 package main

@@ -362,6 +368,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="clearPlaylistContents" method="delete" path="/playlists/{playlistID}/items" -->
 ```go
 package main

@@ -416,6 +423,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="addPlaylistContents" method="put" path="/playlists/{playlistID}/items" -->
 ```go
 package main

@@ -471,6 +479,7 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="uploadPlaylist" method="post" path="/playlists/upload" -->
 ```go
 package main

--- a/docs/sdks/plex/README.md
+++ b/docs/sdks/plex/README.md
@@ -22,6 +22,7 @@ Get Companions Data

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getCompanionsData" method="get" path="/companions" -->
 ```go
 package main

@@ -73,6 +74,7 @@ Get friends of provided auth token.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getUserFriends" method="get" path="/friends" -->
 ```go
 package main

@@ -124,6 +126,7 @@ Returns the geolocation and locale data of the caller

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getGeoData" method="get" path="/geoip" -->
 ```go
 package main

@@ -173,6 +176,7 @@ Retrieves the home data for the authenticated user, including details like home

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getHomeData" method="get" path="/home" -->
 ```go
 package main

@@ -224,6 +228,7 @@ Get Plex server access tokens and server connections

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-server-resources" method="get" path="/resources" -->
 ```go
 package main

@@ -280,6 +285,7 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getPin" method="post" path="/pins" -->
 ```go
 package main

@@ -336,6 +342,7 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTokenByPinId" method="get" path="/pins/{pinID}" -->
 ```go
 package main

--- a/docs/sdks/search/README.md
+++ b/docs/sdks/search/README.md
@@ -30,6 +30,7 @@ This request is intended to be very fast, and called as the user types.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="performSearch" method="get" path="/hubs/search" -->
 ```go
 package main

@@ -88,6 +89,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="performVoiceSearch" method="get" path="/hubs/search/voice" -->
 ```go
 package main

@@ -142,6 +144,7 @@ This will search the database for the string provided.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getSearchResults" method="get" path="/search" -->
 ```go
 package main

--- a/docs/sdks/server/README.md
+++ b/docs/sdks/server/README.md
@@ -24,6 +24,7 @@ Get Server Capabilities

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getServerCapabilities" method="get" path="/" -->
 ```go
 package main

@@ -75,6 +76,7 @@ Get Server Preferences

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getServerPreferences" method="get" path="/:/prefs" -->
 ```go
 package main

@@ -126,6 +128,7 @@ Get Available Clients

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getAvailableClients" method="get" path="/clients" -->
 ```go
 package main

@@ -177,6 +180,7 @@ Get Devices

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getDevices" method="get" path="/devices" -->
 ```go
 package main

@@ -228,6 +232,7 @@ This request is useful to determine if the server is online or offline

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-server-identity" method="get" path="/identity" -->
 ```go
 package main

@@ -276,6 +281,7 @@ Returns MyPlex Account Information

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getMyPlexAccount" method="get" path="/myplex/account" -->
 ```go
 package main

@@ -328,6 +334,7 @@ Plex's Photo transcoder is used throughout the service to serve images at specif

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getResizedPhoto" method="get" path="/photo/:/transcode" -->
 ```go
 package main

@@ -388,6 +395,7 @@ Retrieves media providers and their features from the Plex server.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-media-providers" method="get" path="/media/providers" -->
 ```go
 package main

@@ -440,6 +448,7 @@ Get Server List

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getServerList" method="get" path="/servers" -->
 ```go
 package main

--- a/docs/sdks/sessions/README.md
+++ b/docs/sdks/sessions/README.md
@@ -19,6 +19,7 @@ This will retrieve the "Now Playing" Information of the PMS.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getSessions" method="get" path="/status/sessions" -->
 ```go
 package main

@@ -70,6 +71,7 @@ This will Retrieve a listing of all history views.

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getSessionHistory" method="get" path="/status/sessions/history/all" -->
 ```go
 package main

@@ -126,6 +128,7 @@ Get Transcode Sessions

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTranscodeSessions" method="get" path="/transcode/sessions" -->
 ```go
 package main

@@ -177,6 +180,7 @@ Stop a Transcode Session

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="stopTranscodeSession" method="delete" path="/transcode/sessions/{sessionKey}" -->
 ```go
 package main

--- a/docs/sdks/statistics/README.md
+++ b/docs/sdks/statistics/README.md
@@ -18,6 +18,7 @@ This will return the media statistics for the server

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getStatistics" method="get" path="/statistics/media" -->
 ```go
 package main

@@ -70,6 +71,7 @@ This will return the resources for the server

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getResourcesStatistics" method="get" path="/statistics/resources" -->
 ```go
 package main

@@ -122,6 +124,7 @@ This will return the bandwidth statistics for the server

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getBandwidthStatistics" method="get" path="/statistics/bandwidth" -->
 ```go
 package main

--- a/docs/sdks/updater/README.md
+++ b/docs/sdks/updater/README.md
@@ -19,6 +19,7 @@ Querying status of updates

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getUpdateStatus" method="get" path="/updater/status" -->
 ```go
 package main

@@ -70,6 +71,7 @@ Checking for updates

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="checkForUpdates" method="put" path="/updater/check" -->
 ```go
 package main

@@ -124,6 +126,7 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="applyUpdates" method="put" path="/updater/apply" -->
 ```go
 package main

--- a/docs/sdks/users/README.md
+++ b/docs/sdks/users/README.md
@@ -13,6 +13,7 @@ Get list of all users that are friends and have library access with the provided

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-users" method="get" path="/users" -->
 ```go
 package main

--- a/docs/sdks/video/README.md
+++ b/docs/sdks/video/README.md
@@ -17,6 +17,7 @@ Get the timeline for a media item

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="getTimeline" method="get" path="/:/timeline" -->
 ```go
 package main

@@ -81,6 +82,7 @@ Begin a Universal Transcode Session

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="startUniversalTranscode" method="get" path="/video/:/transcode/universal/start.mpd" -->
 ```go
 package main

--- a/docs/sdks/watchlist/README.md
+++ b/docs/sdks/watchlist/README.md
@@ -16,6 +16,7 @@ Get User Watchlist

 ### Example Usage

+<!-- UsageSnippet language="go" operationID="get-watch-list" method="get" path="/library/sections/watchlist/{filter}" -->
 ```go
 package main