ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.438.1

LukeHagar · Nov 12, 2024 · 66ee477 · 66ee477
1 parent 4fe5e00
commit 66ee477
Show file tree

Hide file tree

Showing 36 changed files with 110 additions and 58 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,19 +1,19 @@
 lockVersion: 2.0.0
 id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f
 management:
-  docChecksum: 23094f3a9fe02710a8628ad5456f5d42
+  docChecksum: af45c1ae70f7fc6589adb3f8075cb275
   docVersion: 0.0.3
-  speakeasyVersion: 1.406.0
-  generationVersion: 2.429.0
-  releaseVersion: 0.4.8
-  configChecksum: 565e24d604aee50353cfdf9eb1ba57a3
+  speakeasyVersion: 1.438.1
+  generationVersion: 2.457.2
+  releaseVersion: 0.5.0
+  configChecksum: 5da078fb62750d5891f7aad21eed4fd4
   repoURL: https://github.com/LukeHagar/plexruby.git
   repoSubDirectory: .
   installationURL: https://github.com/LukeHagar/plexruby
   published: true
 features:
   ruby:
-    core: 3.2.26
+    core: 3.3.0
     deprecations: 2.81.1
     enums: 2.81.1
     flattening: 2.81.1

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -11,8 +11,9 @@ generation:
     requestResponseComponentNamesFeb2024: true
   auth:
     oAuth2ClientCredentialsEnabled: false
+    oAuth2PasswordEnabled: false
 ruby:
-  version: 0.4.8
+  version: 0.5.0
   author: LukeHagar
   description: Ruby Client SDK Generated by Speakeasy
   imports:

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,4 +1,4 @@
-speakeasyVersion: 1.406.0
+speakeasyVersion: 1.438.1
 sources:
     my-source:
         sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
             - main
     plexapi:
         sourceNamespace: plexapi
-        sourceRevisionDigest: sha256:8d2eb3adbd97ce5976291c4b123d1eadfef62d1f6bf86c6a18bcd89443f2f390
-        sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
+        sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
+        sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
         tags:
             - latest
             - main
 targets:
     plexruby:
         source: plexapi
         sourceNamespace: plexapi
-        sourceRevisionDigest: sha256:8d2eb3adbd97ce5976291c4b123d1eadfef62d1f6bf86c6a18bcd89443f2f390
-        sourceBlobDigest: sha256:3e48471b7e058840fc598ccd75b2cbf8187961c7e625fe7b606555ce9a9bf109
+        sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
+        sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
         codeSamplesNamespace: code-samples-ruby-plexruby
-        codeSamplesRevisionDigest: sha256:ec8dce567c47b2af017f3c215fb9a3aabb5c51742d08ac67fc00884a08c4f518
+        codeSamplesRevisionDigest: sha256:938629154cd68c392c74f54af40f28c7dd3c187ce8d52520363269c347077451
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plex_ruby_sdk (0.4.8)
+    plex_ruby_sdk (0.5.0)
       faraday
       faraday-multipart
       rack
@@ -94,7 +94,7 @@ PLATFORMS
 DEPENDENCIES
   minitest
   plex_ruby_sdk!
-  rubocop
+  rubocop (~> 1.60.2)
   sorbet-runtime
   tapioca
 

diff --git a/README.md b/README.md
@@ -95,33 +95,33 @@ end
 <details open>
 <summary>Available methods</summary>
 
-### [Activities](docs/sdks/activities/README.md)
+### [activities](docs/sdks/activities/README.md)
 
 * [get_server_activities](docs/sdks/activities/README.md#get_server_activities) - Get Server Activities
 * [cancel_server_activities](docs/sdks/activities/README.md#cancel_server_activities) - Cancel Server Activities
 
-### [Authentication](docs/sdks/authentication/README.md)
+### [authentication](docs/sdks/authentication/README.md)
 
 * [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token
 * [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
 * [get_token_details](docs/sdks/authentication/README.md#get_token_details) - Get Token Details
 * [post_users_sign_in_data](docs/sdks/authentication/README.md#post_users_sign_in_data) - Get User Sign In Data
 
-### [Butler](docs/sdks/butler/README.md)
+### [butler](docs/sdks/butler/README.md)
 
 * [get_butler_tasks](docs/sdks/butler/README.md#get_butler_tasks) - Get Butler tasks
 * [start_all_tasks](docs/sdks/butler/README.md#start_all_tasks) - Start all Butler tasks
 * [stop_all_tasks](docs/sdks/butler/README.md#stop_all_tasks) - Stop all Butler tasks
 * [start_task](docs/sdks/butler/README.md#start_task) - Start a single Butler task
 * [stop_task](docs/sdks/butler/README.md#stop_task) - Stop a single Butler task
 
-### [Hubs](docs/sdks/hubs/README.md)
+### [hubs](docs/sdks/hubs/README.md)
 
 * [get_global_hubs](docs/sdks/hubs/README.md#get_global_hubs) - Get Global Hubs
 * [get_recently_added](docs/sdks/hubs/README.md#get_recently_added) - Get Recently Added
 * [get_library_hubs](docs/sdks/hubs/README.md#get_library_hubs) - Get library specific hubs
 
-### [Library](docs/sdks/library/README.md)
+### [library](docs/sdks/library/README.md)
 
 * [get_file_hash](docs/sdks/library/README.md#get_file_hash) - Get Hash Value
 * [get_recently_added_library](docs/sdks/library/README.md#get_recently_added_library) - Get Recently Added
@@ -137,21 +137,21 @@ end
 * [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
 * [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
 
-### [Log](docs/sdks/log/README.md)
+### [log](docs/sdks/log/README.md)
 
 * [log_line](docs/sdks/log/README.md#log_line) - Logging a single line message.
 * [log_multi_line](docs/sdks/log/README.md#log_multi_line) - Logging a multi-line message
 * [enable_paper_trail](docs/sdks/log/README.md#enable_paper_trail) - Enabling Papertrail
 
-### [Media](docs/sdks/media/README.md)
+### [media](docs/sdks/media/README.md)
 
 * [mark_played](docs/sdks/media/README.md#mark_played) - Mark Media Played
 * [mark_unplayed](docs/sdks/media/README.md#mark_unplayed) - Mark Media Unplayed
 * [update_play_progress](docs/sdks/media/README.md#update_play_progress) - Update Media Play Progress
 * [get_banner_image](docs/sdks/media/README.md#get_banner_image) - Get Banner Image
 * [get_thumb_image](docs/sdks/media/README.md#get_thumb_image) - Get Thumb Image
 
-### [Playlists](docs/sdks/playlists/README.md)
+### [playlists](docs/sdks/playlists/README.md)
 
 * [create_playlist](docs/sdks/playlists/README.md#create_playlist) - Create a Playlist
 * [get_playlists](docs/sdks/playlists/README.md#get_playlists) - Get All Playlists
@@ -163,7 +163,7 @@ end
 * [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
 * [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
 
-### [Plex](docs/sdks/plex/README.md)
+### [plex](docs/sdks/plex/README.md)
 
 * [get_companions_data](docs/sdks/plex/README.md#get_companions_data) - Get Companions Data
 * [get_user_friends](docs/sdks/plex/README.md#get_user_friends) - Get list of friends of the user logged in
@@ -174,13 +174,13 @@ end
 * [get_token_by_pin_id](docs/sdks/plex/README.md#get_token_by_pin_id) - Get Access Token by PinId
 
 
-### [Search](docs/sdks/search/README.md)
+### [search](docs/sdks/search/README.md)
 
 * [perform_search](docs/sdks/search/README.md#perform_search) - Perform a search
 * [perform_voice_search](docs/sdks/search/README.md#perform_voice_search) - Perform a voice search
 * [get_search_results](docs/sdks/search/README.md#get_search_results) - Get Search Results
 
-### [Server](docs/sdks/server/README.md)
+### [server](docs/sdks/server/README.md)
 
 * [get_server_capabilities](docs/sdks/server/README.md#get_server_capabilities) - Get Server Capabilities
 * [get_server_preferences](docs/sdks/server/README.md#get_server_preferences) - Get Server Preferences
@@ -192,31 +192,31 @@ end
 * [get_media_providers](docs/sdks/server/README.md#get_media_providers) - Get Media Providers
 * [get_server_list](docs/sdks/server/README.md#get_server_list) - Get Server List
 
-### [Sessions](docs/sdks/sessions/README.md)
+### [sessions](docs/sdks/sessions/README.md)
 
 * [get_sessions](docs/sdks/sessions/README.md#get_sessions) - Get Active Sessions
 * [get_session_history](docs/sdks/sessions/README.md#get_session_history) - Get Session History
 * [get_transcode_sessions](docs/sdks/sessions/README.md#get_transcode_sessions) - Get Transcode Sessions
 * [stop_transcode_session](docs/sdks/sessions/README.md#stop_transcode_session) - Stop a Transcode Session
 
-### [Statistics](docs/sdks/statistics/README.md)
+### [statistics](docs/sdks/statistics/README.md)
 
 * [get_statistics](docs/sdks/statistics/README.md#get_statistics) - Get Media Statistics
 * [get_resources_statistics](docs/sdks/statistics/README.md#get_resources_statistics) - Get Resources Statistics
 * [get_bandwidth_statistics](docs/sdks/statistics/README.md#get_bandwidth_statistics) - Get Bandwidth Statistics
 
-### [Updater](docs/sdks/updater/README.md)
+### [updater](docs/sdks/updater/README.md)
 
 * [get_update_status](docs/sdks/updater/README.md#get_update_status) - Querying status of updates
 * [check_for_updates](docs/sdks/updater/README.md#check_for_updates) - Checking for updates
 * [apply_updates](docs/sdks/updater/README.md#apply_updates) - Apply Updates
 
-### [Video](docs/sdks/video/README.md)
+### [video](docs/sdks/video/README.md)
 
 * [get_timeline](docs/sdks/video/README.md#get_timeline) - Get the timeline for a media item
 * [start_universal_transcode](docs/sdks/video/README.md#start_universal_transcode) - Start Universal Transcode
 
-### [Watchlist](docs/sdks/watchlist/README.md)
+### [watchlist](docs/sdks/watchlist/README.md)
 
 * [get_watch_list](docs/sdks/watchlist/README.md#get_watch_list) - Get User Watchlist
 
@@ -226,29 +226,42 @@ end
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-## Server Selection
-
-### Select Server by Index
+### Server Variables
 
-You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
-
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
+The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
+ * `protocol (::PlexRubySDK::ServerVariables::ServerProtocol)`
+ * `ip (::String)`
+ * `port (::String)`
 
+### Override Server URL Per-Client
 
+The default server can also be overridden globally by passing a URL to the `server_url (String)` optional parameter when initializing the SDK client instance. For example:
+```ruby
+require 'plex_ruby_sdk'
 
-#### Variables
 
-Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
- * `protocol: ::PlexRubySDK::ServerVariables::ServerProtocol`
- * `ip: ::String`
- * `port: ::String`
+s = ::PlexRubySDK::PlexAPI.new(
+      server_url: "https://10.10.10.47:32400",
+      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
+      client_name: "Plex for Roku",
+      client_version: "2.4.1",
+      platform: "Roku",
+      device_nickname: "Roku 3",
+    )
+s.config_security(
+  ::PlexRubySDK::Shared::Security.new(
+    access_token: "<YOUR_API_KEY_HERE>",
+  )
+)
 
-### Override Server URL Per-Client
+
+res = s.server.get_server_capabilities()
 
-The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+if ! res.object.nil?
+  # handle response
+end
 
+```
 
 ### Override Server URL Per-Operation
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -626,4 +626,14 @@ Based on:
 ### Generated
 - [ruby v0.4.8] .
 ### Releases
-- [Ruby Gems v0.4.8] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.8 - .
+- [Ruby Gems v0.4.8] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.8 - .
+
+## 2024-11-12 00:07:41
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v0.5.0] .
+### Releases
+- [Ruby Gems v0.5.0] https://rubygems.org/gems/plex_ruby_sdk/versions/0.5.0 - .
diff --git a/docs/models/operations/getlibraryitemsqueryparamtype.md b/docs/models/operations/getlibraryitemsqueryparamtype.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/models/operations/getplaylistcontentsqueryparamtype.md b/docs/models/operations/getplaylistcontentsqueryparamtype.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/models/operations/getsearchlibraryqueryparamtype.md b/docs/models/operations/getsearchlibraryqueryparamtype.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/models/operations/gettopwatchedcontentqueryparamtype.md b/docs/models/operations/gettopwatchedcontentqueryparamtype.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/models/operations/queryparamtype.md b/docs/models/operations/queryparamtype.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/models/operations/type.md b/docs/models/operations/type.md
@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
 | `MOVIE`   | 1         |
 | `TV_SHOW` | 2         |
 | `SEASON`  | 3         |
-| `EPISODE` | 4         |
+| `EPISODE` | 4         |
+| `AUDIO`   | 8         |
diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md
@@ -1,4 +1,5 @@
 # Activities
+(*activities*)
 
 ## Overview
 

diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md
@@ -1,4 +1,5 @@
 # Authentication
+(*authentication*)
 
 ## Overview
 

diff --git a/docs/sdks/butler/README.md b/docs/sdks/butler/README.md
@@ -1,4 +1,5 @@
 # Butler
+(*butler*)
 
 ## Overview
 

diff --git a/docs/sdks/hubs/README.md b/docs/sdks/hubs/README.md
@@ -1,4 +1,5 @@
 # Hubs
+(*hubs*)
 
 ## Overview
 

diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md
@@ -1,4 +1,5 @@
 # Library
+(*library*)
 
 ## Overview
 

diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md
@@ -1,4 +1,5 @@
 # Log
+(*log*)
 
 ## Overview
 

diff --git a/docs/sdks/media/README.md b/docs/sdks/media/README.md
@@ -1,4 +1,5 @@
 # Media
+(*media*)
 
 ## Overview
 

diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md
@@ -1,4 +1,5 @@
 # Playlists
+(*playlists*)
 
 ## Overview
 

diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md
@@ -1,4 +1,5 @@
 # Plex
+(*plex*)
 
 ## Overview