diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 0c8aa83..d151080 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f management: - docChecksum: f387ae03f10decba230886eaab322b20 + docChecksum: f12b653820ae77ca3b2820bc9459d866 docVersion: 0.0.3 - speakeasyVersion: 1.404.5 - generationVersion: 2.426.2 - releaseVersion: 0.4.5 - configChecksum: 485b660499b1eb08446582eccf4035da + speakeasyVersion: 1.405.6 + generationVersion: 2.428.1 + releaseVersion: 0.4.6 + configChecksum: 75cf8089cef876153424b3f32b73ab87 repoURL: https://github.com/LukeHagar/plexruby.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/plexruby published: true features: ruby: - core: 3.2.25 + core: 3.2.26 deprecations: 2.81.1 enums: 2.81.1 flattening: 2.81.1 diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 75ba31f..cc829cf 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false ruby: - version: 0.4.5 + version: 0.4.6 author: LukeHagar description: Ruby Client SDK Generated by Speakeasy imports: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 67be940..41a5403 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.404.5 +speakeasyVersion: 1.405.6 sources: my-source: sourceNamespace: my-source @@ -9,8 +9,8 @@ sources: - main plexapi: sourceNamespace: plexapi - sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c - sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98 + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 tags: - latest - main @@ -18,10 +18,10 @@ targets: plexruby: source: plexapi sourceNamespace: plexapi - sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c - sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98 + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 codeSamplesNamespace: code-samples-ruby-plexruby - codeSamplesRevisionDigest: sha256:fbfa11d155d5c73bed6140bb9afdad2c3d3735ea2b000b2a6966a54088d09c3b + codeSamplesRevisionDigest: sha256:9e29da1762cbdc612d7f42b05357b40f20cd9a8d7fa59da610f148b84219a34b workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/Gemfile.lock b/Gemfile.lock index 87b11b0..0d9d394 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - plex_ruby_sdk (0.4.5) + plex_ruby_sdk (0.4.6) faraday faraday-multipart rack diff --git a/README.md b/README.md index bbb1544..820642f 100644 --- a/README.md +++ b/README.md @@ -294,10 +294,7 @@ The following global parameters are available. | Name | Type | Required | Description | | ---- | ---- |:--------:| ----------- | -| client_id | ::String | | The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - | +| client_id | ::String | | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | | client_name | ::String | | The client_name parameter. | | client_version | ::String | | The client_version parameter. | | client_platform | ::String | | The client_platform parameter. | diff --git a/RELEASES.md b/RELEASES.md index 858b5e7..0b14fe6 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -596,4 +596,14 @@ Based on: ### Generated - [ruby v0.4.5] . ### Releases -- [Ruby Gems v0.4.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.5 - . \ No newline at end of file +- [Ruby Gems v0.4.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.5 - . + +## 2024-10-01 00:08:27 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v0.4.6] . +### Releases +- [Ruby Gems v0.4.6] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.6 - . \ No newline at end of file diff --git a/docs/models/operations/getpinrequest.md b/docs/models/operations/getpinrequest.md index 9799224..3bee400 100644 --- a/docs/models/operations/getpinrequest.md +++ b/docs/models/operations/getpinrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | -| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | +| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/getserverresourcesrequest.md b/docs/models/operations/getserverresourcesrequest.md index adcb9e1..517310c 100644 --- a/docs/models/operations/getserverresourcesrequest.md +++ b/docs/models/operations/getserverresourcesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | -| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | -| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | +| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | +| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | +| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file diff --git a/docs/models/operations/gettokenbypinidrequest.md b/docs/models/operations/gettokenbypinidrequest.md index 2874206..06363eb 100644 --- a/docs/models/operations/gettokenbypinidrequest.md +++ b/docs/models/operations/gettokenbypinidrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | | -| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindatarequest.md b/docs/models/operations/postuserssignindatarequest.md index cfabecc..f2fa913 100644 --- a/docs/models/operations/postuserssignindatarequest.md +++ b/docs/models/operations/postuserssignindatarequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | -| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome | +| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 23b3752..805e877 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -54,7 +54,6 @@ end - ## cancel_server_activities Cancel Server Activities @@ -97,4 +96,3 @@ end **[T.nilable(::PlexRubySDK::Operations::CancelServerActivitiesResponse)](../../models/operations/cancelserveractivitiesresponse.md)** - diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md index 87564c7..dcd0334 100644 --- a/docs/sdks/authentication/README.md +++ b/docs/sdks/authentication/README.md @@ -58,7 +58,6 @@ end - ## get_source_connection_information If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. @@ -105,7 +104,6 @@ end - ## get_token_details Get the User data from the provided X-Plex-Token @@ -150,7 +148,6 @@ end - ## post_users_sign_in_data Sign in user with username and password and return user data with Plex authentication token @@ -197,4 +194,3 @@ end **[T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataResponse)](../../models/operations/postuserssignindataresponse.md)** - diff --git a/docs/sdks/butler/README.md b/docs/sdks/butler/README.md index d4d8684..e00ec77 100644 --- a/docs/sdks/butler/README.md +++ b/docs/sdks/butler/README.md @@ -51,7 +51,6 @@ end - ## start_all_tasks This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria: @@ -95,7 +94,6 @@ end - ## stop_all_tasks This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue. @@ -135,7 +133,6 @@ end - ## start_task This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria: @@ -185,7 +182,6 @@ end - ## stop_task This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint. @@ -229,4 +225,3 @@ end **[T.nilable(::PlexRubySDK::Operations::StopTaskResponse)](../../models/operations/stoptaskresponse.md)** - diff --git a/docs/sdks/hubs/README.md b/docs/sdks/hubs/README.md index 59f57f4..205238b 100644 --- a/docs/sdks/hubs/README.md +++ b/docs/sdks/hubs/README.md @@ -56,7 +56,6 @@ end - ## get_recently_added This endpoint will return the recently added content. @@ -111,7 +110,6 @@ end - ## get_library_hubs This endpoint will return a list of library specific hubs @@ -157,4 +155,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetLibraryHubsResponse)](../../models/operations/getlibraryhubsresponse.md)** - diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md index d6a43db..094deff 100644 --- a/docs/sdks/library/README.md +++ b/docs/sdks/library/README.md @@ -65,7 +65,6 @@ end - ## get_recently_added_library This endpoint will return the recently added content. @@ -134,7 +133,6 @@ end - ## get_all_libraries A library section (commonly referred to as just a library) is a collection of media. @@ -179,7 +177,6 @@ end - ## get_library_details ## Library Details Endpoint @@ -264,7 +261,6 @@ end - ## delete_library Delete a library using a specific section id @@ -309,7 +305,6 @@ end - ## get_library_items Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values: @@ -384,7 +379,6 @@ end - ## get_refresh_library_metadata This endpoint Refreshes all the Metadata of the library. @@ -431,7 +425,6 @@ end - ## get_search_library Search for content within a specific section of the library. @@ -495,7 +488,6 @@ end - ## get_meta_data_by_rating_key This endpoint will return the metadata of a library item specified with the ratingKey. @@ -541,7 +533,6 @@ end - ## get_metadata_children This endpoint will return the children of of a library item specified with the ratingKey. @@ -588,7 +579,6 @@ end - ## get_top_watched_content This endpoint will return the top watched content from libraries of a certain type @@ -635,7 +625,6 @@ end - ## get_on_deck This endpoint will return the on deck content. @@ -673,4 +662,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetOnDeckResponse)](../../models/operations/getondeckresponse.md)** - diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md index 97414ef..17b7687 100644 --- a/docs/sdks/log/README.md +++ b/docs/sdks/log/README.md @@ -58,7 +58,6 @@ end - ## log_multi_line This endpoint allows for the batch addition of log entries to the main Plex Media Server log. @@ -128,7 +127,6 @@ end - ## enable_paper_trail This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. @@ -166,4 +164,3 @@ end **[T.nilable(::PlexRubySDK::Operations::EnablePaperTrailResponse)](../../models/operations/enablepapertrailresponse.md)** - diff --git a/docs/sdks/media/README.md b/docs/sdks/media/README.md index 0b4c32c..4486766 100644 --- a/docs/sdks/media/README.md +++ b/docs/sdks/media/README.md @@ -57,7 +57,6 @@ end - ## mark_unplayed This will mark the provided media key as Unplayed. @@ -102,7 +101,6 @@ end - ## update_play_progress This API command can be used to update the play progress of a media item. @@ -150,7 +148,6 @@ end - ## get_banner_image Gets the banner image of the media item @@ -204,7 +201,6 @@ end - ## get_thumb_image Gets the thumbnail image of the media item @@ -256,4 +252,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetThumbImageResponse)](../../models/operations/getthumbimageresponse.md)** - diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md index 156bdc7..e5762d6 100644 --- a/docs/sdks/playlists/README.md +++ b/docs/sdks/playlists/README.md @@ -74,7 +74,6 @@ end - ## get_playlists Get All Playlists given the specified filters. @@ -120,7 +119,6 @@ end - ## get_playlist Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item: @@ -167,7 +165,6 @@ end - ## delete_playlist This endpoint will delete a playlist @@ -213,7 +210,6 @@ end - ## update_playlist From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}` @@ -261,7 +257,6 @@ end - ## get_playlist_contents Gets the contents of a playlist. Should be paged by clients via standard mechanisms. @@ -311,7 +306,6 @@ end - ## clear_playlist_contents Clears a playlist, only works with dumb playlists. Returns the playlist. @@ -357,7 +351,6 @@ end - ## add_playlist_contents Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. @@ -406,7 +399,6 @@ end - ## upload_playlist Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file. @@ -452,4 +444,3 @@ end **[T.nilable(::PlexRubySDK::Operations::UploadPlaylistResponse)](../../models/operations/uploadplaylistresponse.md)** - diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md index b025417..5a6c2e8 100644 --- a/docs/sdks/plex/README.md +++ b/docs/sdks/plex/README.md @@ -59,7 +59,6 @@ end - ## get_user_friends Get friends of provided auth token. @@ -104,7 +103,6 @@ end - ## get_geo_data Returns the geolocation and locale data of the caller @@ -144,7 +142,6 @@ end - ## get_home_data Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status. @@ -183,7 +180,6 @@ end - ## get_server_resources Get Plex server access tokens and server connections @@ -218,13 +214,13 @@ end ### Parameters -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_https` | [::PlexRubySDK::Operations::IncludeHttps](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | -| `include_relay` | [::PlexRubySDK::Operations::IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `include_i_pv6` | [::PlexRubySDK::Operations::IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | -| `client_id` | *::String* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| gcgzw5rz2xovp84b4vha3a40 | -| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `include_https` | [::PlexRubySDK::Operations::IncludeHttps](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | +| `include_relay` | [::PlexRubySDK::Operations::IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | +| `include_i_pv6` | [::PlexRubySDK::Operations::IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | +| `client_id` | *::String* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 | +| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | ### Response @@ -232,7 +228,6 @@ end - ## get_pin Retrieve a Pin ID from Plex.tv to use for authentication flows @@ -275,7 +270,6 @@ end - ## get_token_by_pin_id Retrieve an Access Token from Plex.tv after the Pin has been authenticated @@ -318,4 +312,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetTokenByPinIdResponse)](../../models/operations/gettokenbypinidresponse.md)** - diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index a2db62a..5ca5fd0 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -69,7 +69,6 @@ end - ## perform_voice_search This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint. @@ -120,7 +119,6 @@ end - ## get_search_results This will search the database for the string provided. @@ -163,4 +161,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetSearchResultsResponse)](../../models/operations/getsearchresultsresponse.md)** - diff --git a/docs/sdks/server/README.md b/docs/sdks/server/README.md index c82b734..0a9449a 100644 --- a/docs/sdks/server/README.md +++ b/docs/sdks/server/README.md @@ -55,7 +55,6 @@ end - ## get_server_preferences Get Server Preferences @@ -94,7 +93,6 @@ end - ## get_available_clients Get Available Clients @@ -133,7 +131,6 @@ end - ## get_devices Get Devices @@ -172,7 +169,6 @@ end - ## get_server_identity This request is useful to determine if the server is online or offline @@ -206,7 +202,6 @@ end - ## get_my_plex_account Returns MyPlex Account Information @@ -245,7 +240,6 @@ end - ## get_resized_photo Plex's Photo transcoder is used throughout the service to serve images at specified sizes. @@ -301,7 +295,6 @@ end - ## get_media_providers Retrieves media providers and their features from the Plex server. @@ -346,7 +339,6 @@ end - ## get_server_list Get Server List @@ -383,4 +375,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetServerListResponse)](../../models/operations/getserverlistresponse.md)** - diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index 7c8d8eb..5bb246a 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -50,7 +50,6 @@ end - ## get_session_history This will Retrieve a listing of all history views. @@ -98,7 +97,6 @@ end - ## get_transcode_sessions Get Transcode Sessions @@ -137,7 +135,6 @@ end - ## stop_transcode_session Stop a Transcode Session @@ -180,4 +177,3 @@ end **[T.nilable(::PlexRubySDK::Operations::StopTranscodeSessionResponse)](../../models/operations/stoptranscodesessionresponse.md)** - diff --git a/docs/sdks/statistics/README.md b/docs/sdks/statistics/README.md index 6e3c56a..0ca45ca 100644 --- a/docs/sdks/statistics/README.md +++ b/docs/sdks/statistics/README.md @@ -55,7 +55,6 @@ end - ## get_resources_statistics This will return the resources for the server @@ -100,7 +99,6 @@ end - ## get_bandwidth_statistics This will return the bandwidth statistics for the server @@ -143,4 +141,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetBandwidthStatisticsResponse)](../../models/operations/getbandwidthstatisticsresponse.md)** - diff --git a/docs/sdks/updater/README.md b/docs/sdks/updater/README.md index b149a5d..ad3ae04 100644 --- a/docs/sdks/updater/README.md +++ b/docs/sdks/updater/README.md @@ -50,7 +50,6 @@ end - ## check_for_updates Checking for updates @@ -95,7 +94,6 @@ end - ## apply_updates Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed @@ -140,4 +138,3 @@ end **[T.nilable(::PlexRubySDK::Operations::ApplyUpdatesResponse)](../../models/operations/applyupdatesresponse.md)** - diff --git a/docs/sdks/video/README.md b/docs/sdks/video/README.md index af85b32..f54f8e1 100644 --- a/docs/sdks/video/README.md +++ b/docs/sdks/video/README.md @@ -67,7 +67,6 @@ end - ## start_universal_transcode Begin a Universal Transcode Session @@ -129,4 +128,3 @@ end **[T.nilable(::PlexRubySDK::Operations::StartUniversalTranscodeResponse)](../../models/operations/startuniversaltranscoderesponse.md)** - diff --git a/docs/sdks/watchlist/README.md b/docs/sdks/watchlist/README.md index 4380fd1..cc0fbfe 100644 --- a/docs/sdks/watchlist/README.md +++ b/docs/sdks/watchlist/README.md @@ -59,4 +59,3 @@ end **[T.nilable(::PlexRubySDK::Operations::GetWatchListResponse)](../../models/operations/getwatchlistresponse.md)** - diff --git a/lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb b/lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb index c7c378a..3586e01 100644 --- a/lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb +++ b/lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb @@ -14,10 +14,7 @@ module PlexRubySDK class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented extend T::Sig - # The unique identifier for the client application - # This is used to track the client application and its usage - # (UUID, serial number, or other number unique per device) - # + # The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } # Include Https entries in the results field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } } diff --git a/lib/plex_ruby_sdk/models/operations/getpin_request.rb b/lib/plex_ruby_sdk/models/operations/getpin_request.rb index c9078bd..022bb85 100644 --- a/lib/plex_ruby_sdk/models/operations/getpin_request.rb +++ b/lib/plex_ruby_sdk/models/operations/getpin_request.rb @@ -14,10 +14,7 @@ module PlexRubySDK class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented extend T::Sig - # The unique identifier for the client application - # This is used to track the client application and its usage - # (UUID, serial number, or other number unique per device) - # + # The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } } diff --git a/lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb b/lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb index ff51c7b..e135fa4 100644 --- a/lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb +++ b/lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb @@ -16,10 +16,7 @@ module PlexRubySDK # The PinID to retrieve an access token for field :pin_id, ::Integer, { 'path_param': { 'field_name': 'pinID', 'style': 'simple', 'explode': false } } - # The unique identifier for the client application - # This is used to track the client application and its usage - # (UUID, serial number, or other number unique per device) - # + # The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } } diff --git a/lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb b/lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb index d12cc4f..703f692 100644 --- a/lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb +++ b/lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb @@ -14,10 +14,7 @@ module PlexRubySDK class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented extend T::Sig - # The unique identifier for the client application - # This is used to track the client application and its usage - # (UUID, serial number, or other number unique per device) - # + # The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } } diff --git a/lib/plex_ruby_sdk/sdkconfiguration.rb b/lib/plex_ruby_sdk/sdkconfiguration.rb index 8963782..44d618a 100644 --- a/lib/plex_ruby_sdk/sdkconfiguration.rb +++ b/lib/plex_ruby_sdk/sdkconfiguration.rb @@ -42,9 +42,9 @@ module PlexRubySDK @globals = globals.nil? ? {} : globals @language = 'ruby' @openapi_doc_version = '0.0.3' - @sdk_version = '0.4.5' - @gen_version = '2.426.2' - @user_agent = 'speakeasy-sdk/ruby 0.4.5 2.426.2 0.0.3 plex_ruby_sdk' + @sdk_version = '0.4.6' + @gen_version = '2.428.1' + @user_agent = 'speakeasy-sdk/ruby 0.4.6 2.428.1 0.0.3 plex_ruby_sdk' end sig { returns([String, T::Hash[Symbol, String]]) } diff --git a/plex_ruby_sdk.gemspec b/plex_ruby_sdk.gemspec index cb4fc0d..9c93036 100644 --- a/plex_ruby_sdk.gemspec +++ b/plex_ruby_sdk.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'plex_ruby_sdk' - s.version = '0.4.5' + s.version = '0.4.6' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = ''