LukeParke/plexruby
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexruby.git synced 2025-12-06 12:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6

Browse Source
This commit is contained in:
speakeasybot
2024-10-01 00:10:12 +00:00
parent dc2f64115c
commit d8100e0e9a
32 changed files with 71 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.speakeasy/gen.lock
View File

@@ -1,19 +1,19 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f
management: management:
docChecksum: f387ae03f10decba230886eaab322b20 docChecksum: f12b653820ae77ca3b2820bc9459d866
docVersion: 0.0.3 docVersion: 0.0.3
speakeasyVersion: 1.404.5 speakeasyVersion: 1.405.6
generationVersion: 2.426.2 generationVersion: 2.428.1
releaseVersion: 0.4.5 releaseVersion: 0.4.6
configChecksum: 485b660499b1eb08446582eccf4035da configChecksum: 75cf8089cef876153424b3f32b73ab87
repoURL: https://github.com/LukeHagar/plexruby.git repoURL: https://github.com/LukeHagar/plexruby.git
repoSubDirectory: . repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexruby installationURL: https://github.com/LukeHagar/plexruby
published: true published: true
features: features:
ruby: ruby:
core: 3.2.25 core: 3.2.26
deprecations: 2.81.1 deprecations: 2.81.1
enums: 2.81.1 enums: 2.81.1
flattening: 2.81.1 flattening: 2.81.1

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth: auth:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
ruby: ruby:
version: 0.4.5 version: 0.4.6
author: LukeHagar author: LukeHagar
description: Ruby Client SDK Generated by Speakeasy description: Ruby Client SDK Generated by Speakeasy
imports: imports:

12
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.404.5 speakeasyVersion: 1.405.6
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98 sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
plexruby: plexruby:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:a9bd67eaa35b8311162ae769209f725cc5da16e57976b4928c54594c02cd451c sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
sourceBlobDigest: sha256:43ddffba137c37d2f64f8db185179a273bcc5ca7242594c932da99d1eb7f3e98 sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
codeSamplesNamespace: code-samples-ruby-plexruby codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:fbfa11d155d5c73bed6140bb9afdad2c3d3735ea2b000b2a6966a54088d09c3b codeSamplesRevisionDigest: sha256:9e29da1762cbdc612d7f42b05357b40f20cd9a8d7fa59da610f148b84219a34b
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

2
Gemfile.lock
View File

@@ -1,7 +1,7 @@
PATH PATH
remote: . remote: .
specs: specs:
plex_ruby_sdk (0.4.5) plex_ruby_sdk (0.4.6)
faraday faraday
faraday-multipart faraday-multipart
rack rack

5
README.md
View File

@@ -294,10 +294,7 @@ The following global parameters are available.
| Name | Type | Required | Description | | Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- | | ---- | ---- |:--------:| ----------- |
| client_id | ::String | | The unique identifier for the client application | 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) |
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_name | ::String | | The client_name parameter. |
| client_version | ::String | | The client_version parameter. | | client_version | ::String | | The client_version parameter. |
| client_platform | ::String | | The client_platform parameter. | | client_platform | ::String | | The client_platform parameter. |

10
RELEASES.md
View File

@@ -597,3 +597,13 @@ Based on:
- [ruby v0.4.5] . - [ruby v0.4.5] .
### Releases ### Releases
- [Ruby Gems v0.4.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.5 - . - [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 - .

4
docs/models/operations/getpinrequest.md
View File

@@ -4,9 +4,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | | | `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `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 | | `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | | `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_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |

4
docs/models/operations/getserverresourcesrequest.md
View File

@@ -4,8 +4,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | 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_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 <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 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<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `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 |

4
docs/models/operations/gettokenbypinidrequest.md
View File

@@ -4,9 +4,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `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<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `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 | | `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | | `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_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |

4
docs/models/operations/postuserssignindatarequest.md
View File

@@ -4,8 +4,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `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 | | `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux | | `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_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |

2
docs/sdks/activities/README.md
View File

@@ -54,7 +54,6 @@ end
## cancel_server_activities ## cancel_server_activities
Cancel Server Activities Cancel Server Activities
@@ -97,4 +96,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::CancelServerActivitiesResponse)](../../models/operations/cancelserveractivitiesresponse.md)** **[T.nilable(::PlexRubySDK::Operations::CancelServerActivitiesResponse)](../../models/operations/cancelserveractivitiesresponse.md)**

4
docs/sdks/authentication/README.md
View File

@@ -58,7 +58,6 @@ end
## get_source_connection_information ## 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. 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_token_details
Get the User data from the provided X-Plex-Token Get the User data from the provided X-Plex-Token
@@ -150,7 +148,6 @@ end
## post_users_sign_in_data ## post_users_sign_in_data
Sign in user with username and password and return user data with Plex authentication token 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)** **[T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataResponse)](../../models/operations/postuserssignindataresponse.md)**

5
docs/sdks/butler/README.md
View File

@@ -51,7 +51,6 @@ end
## start_all_tasks ## 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: 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 ## stop_all_tasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue. This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
@@ -135,7 +133,6 @@ end
## start_task ## 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: 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 ## 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. 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)** **[T.nilable(::PlexRubySDK::Operations::StopTaskResponse)](../../models/operations/stoptaskresponse.md)**

3
docs/sdks/hubs/README.md
View File

@@ -56,7 +56,6 @@ end
## get_recently_added ## get_recently_added
This endpoint will return the recently added content. This endpoint will return the recently added content.
@@ -111,7 +110,6 @@ end
## get_library_hubs ## get_library_hubs
This endpoint will return a list of library specific 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)** **[T.nilable(::PlexRubySDK::Operations::GetLibraryHubsResponse)](../../models/operations/getlibraryhubsresponse.md)**

12
docs/sdks/library/README.md
View File

@@ -65,7 +65,6 @@ end
## get_recently_added_library ## get_recently_added_library
This endpoint will return the recently added content. This endpoint will return the recently added content.
@@ -134,7 +133,6 @@ end
## get_all_libraries ## get_all_libraries
A library section (commonly referred to as just a library) is a collection of media. A library section (commonly referred to as just a library) is a collection of media.
@@ -179,7 +177,6 @@ end
## get_library_details ## get_library_details
## Library Details Endpoint ## Library Details Endpoint
@@ -264,7 +261,6 @@ end
## delete_library ## delete_library
Delete a library using a specific section id Delete a library using a specific section id
@@ -309,7 +305,6 @@ end
## get_library_items ## 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: 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 ## get_refresh_library_metadata
This endpoint Refreshes all the Metadata of the library. This endpoint Refreshes all the Metadata of the library.
@@ -431,7 +425,6 @@ end
## get_search_library ## get_search_library
Search for content within a specific section of the library. Search for content within a specific section of the library.
@@ -495,7 +488,6 @@ end
## get_meta_data_by_rating_key ## get_meta_data_by_rating_key
This endpoint will return the metadata of a library item specified with the ratingKey. This endpoint will return the metadata of a library item specified with the ratingKey.
@@ -541,7 +533,6 @@ end
## get_metadata_children ## get_metadata_children
This endpoint will return the children of of a library item specified with the ratingKey. This endpoint will return the children of of a library item specified with the ratingKey.
@@ -588,7 +579,6 @@ end
## get_top_watched_content ## get_top_watched_content
This endpoint will return the top watched content from libraries of a certain type This endpoint will return the top watched content from libraries of a certain type
@@ -635,7 +625,6 @@ end
## get_on_deck ## get_on_deck
This endpoint will return the on deck content. This endpoint will return the on deck content.
@@ -673,4 +662,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetOnDeckResponse)](../../models/operations/getondeckresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetOnDeckResponse)](../../models/operations/getondeckresponse.md)**

3
docs/sdks/log/README.md
View File

@@ -58,7 +58,6 @@ end
## log_multi_line ## log_multi_line
This endpoint allows for the batch addition of log entries to the main Plex Media Server log. 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 ## 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. 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)** **[T.nilable(::PlexRubySDK::Operations::EnablePaperTrailResponse)](../../models/operations/enablepapertrailresponse.md)**

5
docs/sdks/media/README.md
View File

@@ -57,7 +57,6 @@ end
## mark_unplayed ## mark_unplayed
This will mark the provided media key as Unplayed. This will mark the provided media key as Unplayed.
@@ -102,7 +101,6 @@ end
## update_play_progress ## update_play_progress
This API command can be used to update the play progress of a media item. This API command can be used to update the play progress of a media item.
@@ -150,7 +148,6 @@ end
## get_banner_image ## get_banner_image
Gets the banner image of the media item Gets the banner image of the media item
@@ -204,7 +201,6 @@ end
## get_thumb_image ## get_thumb_image
Gets the thumbnail image of the media item Gets the thumbnail image of the media item
@@ -256,4 +252,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetThumbImageResponse)](../../models/operations/getthumbimageresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetThumbImageResponse)](../../models/operations/getthumbimageresponse.md)**

9
docs/sdks/playlists/README.md
View File

@@ -74,7 +74,6 @@ end
## get_playlists ## get_playlists
Get All Playlists given the specified filters. Get All Playlists given the specified filters.
@@ -120,7 +119,6 @@ end
## get_playlist ## 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: 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 ## delete_playlist
This endpoint will delete a playlist This endpoint will delete a playlist
@@ -213,7 +210,6 @@ end
## update_playlist ## 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}` 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 ## get_playlist_contents
Gets the contents of a playlist. Should be paged by clients via standard mechanisms. Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
@@ -311,7 +306,6 @@ end
## clear_playlist_contents ## clear_playlist_contents
Clears a playlist, only works with dumb playlists. Returns the playlist. Clears a playlist, only works with dumb playlists. Returns the playlist.
@@ -357,7 +351,6 @@ end
## add_playlist_contents ## 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. 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 ## 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. 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)** **[T.nilable(::PlexRubySDK::Operations::UploadPlaylistResponse)](../../models/operations/uploadplaylistresponse.md)**

11
docs/sdks/plex/README.md
View File

@@ -59,7 +59,6 @@ end
## get_user_friends ## get_user_friends
Get friends of provided auth token. Get friends of provided auth token.
@@ -104,7 +103,6 @@ end
## get_geo_data ## get_geo_data
Returns the geolocation and locale data of the caller Returns the geolocation and locale data of the caller
@@ -144,7 +142,6 @@ end
## get_home_data ## get_home_data
Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status. 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_server_resources
Get Plex server access tokens and server connections Get Plex server access tokens and server connections
@@ -219,11 +215,11 @@ end
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | 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_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 <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `include_relay` | [::PlexRubySDK::Operations::IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [::PlexRubySDK::Operations::IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 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<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `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 | | `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response ### Response
@@ -232,7 +228,6 @@ end
## get_pin ## get_pin
Retrieve a Pin ID from Plex.tv to use for authentication flows Retrieve a Pin ID from Plex.tv to use for authentication flows
@@ -275,7 +270,6 @@ end
## get_token_by_pin_id ## get_token_by_pin_id
Retrieve an Access Token from Plex.tv after the Pin has been authenticated 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)** **[T.nilable(::PlexRubySDK::Operations::GetTokenByPinIdResponse)](../../models/operations/gettokenbypinidresponse.md)**

3
docs/sdks/search/README.md
View File

@@ -69,7 +69,6 @@ end
## perform_voice_search ## 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. 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 ## get_search_results
This will search the database for the string provided. This will search the database for the string provided.
@@ -163,4 +161,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetSearchResultsResponse)](../../models/operations/getsearchresultsresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetSearchResultsResponse)](../../models/operations/getsearchresultsresponse.md)**

9
docs/sdks/server/README.md
View File

@@ -55,7 +55,6 @@ end
## get_server_preferences ## get_server_preferences
Get Server Preferences Get Server Preferences
@@ -94,7 +93,6 @@ end
## get_available_clients ## get_available_clients
Get Available Clients Get Available Clients
@@ -133,7 +131,6 @@ end
## get_devices ## get_devices
Get Devices Get Devices
@@ -172,7 +169,6 @@ end
## get_server_identity ## get_server_identity
This request is useful to determine if the server is online or offline This request is useful to determine if the server is online or offline
@@ -206,7 +202,6 @@ end
## get_my_plex_account ## get_my_plex_account
Returns MyPlex Account Information Returns MyPlex Account Information
@@ -245,7 +240,6 @@ end
## get_resized_photo ## get_resized_photo
Plex's Photo transcoder is used throughout the service to serve images at specified sizes. Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
@@ -301,7 +295,6 @@ end
## get_media_providers ## get_media_providers
Retrieves media providers and their features from the Plex server. Retrieves media providers and their features from the Plex server.
@@ -346,7 +339,6 @@ end
## get_server_list ## get_server_list
Get Server List Get Server List
@@ -383,4 +375,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetServerListResponse)](../../models/operations/getserverlistresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetServerListResponse)](../../models/operations/getserverlistresponse.md)**

4
docs/sdks/sessions/README.md
View File

@@ -50,7 +50,6 @@ end
## get_session_history ## get_session_history
This will Retrieve a listing of all history views. This will Retrieve a listing of all history views.
@@ -98,7 +97,6 @@ end
## get_transcode_sessions ## get_transcode_sessions
Get Transcode Sessions Get Transcode Sessions
@@ -137,7 +135,6 @@ end
## stop_transcode_session ## stop_transcode_session
Stop a Transcode Session Stop a Transcode Session
@@ -180,4 +177,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::StopTranscodeSessionResponse)](../../models/operations/stoptranscodesessionresponse.md)** **[T.nilable(::PlexRubySDK::Operations::StopTranscodeSessionResponse)](../../models/operations/stoptranscodesessionresponse.md)**

3
docs/sdks/statistics/README.md
View File

@@ -55,7 +55,6 @@ end
## get_resources_statistics ## get_resources_statistics
This will return the resources for the server This will return the resources for the server
@@ -100,7 +99,6 @@ end
## get_bandwidth_statistics ## get_bandwidth_statistics
This will return the bandwidth statistics for the server This will return the bandwidth statistics for the server
@@ -143,4 +141,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetBandwidthStatisticsResponse)](../../models/operations/getbandwidthstatisticsresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetBandwidthStatisticsResponse)](../../models/operations/getbandwidthstatisticsresponse.md)**

3
docs/sdks/updater/README.md
View File

@@ -50,7 +50,6 @@ end
## check_for_updates ## check_for_updates
Checking for updates Checking for updates
@@ -95,7 +94,6 @@ end
## apply_updates ## 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 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)** **[T.nilable(::PlexRubySDK::Operations::ApplyUpdatesResponse)](../../models/operations/applyupdatesresponse.md)**

2
docs/sdks/video/README.md
View File

@@ -67,7 +67,6 @@ end
## start_universal_transcode ## start_universal_transcode
Begin a Universal Transcode Session Begin a Universal Transcode Session
@@ -129,4 +128,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::StartUniversalTranscodeResponse)](../../models/operations/startuniversaltranscoderesponse.md)** **[T.nilable(::PlexRubySDK::Operations::StartUniversalTranscodeResponse)](../../models/operations/startuniversaltranscoderesponse.md)**

1
docs/sdks/watchlist/README.md
View File

@@ -59,4 +59,3 @@ end
**[T.nilable(::PlexRubySDK::Operations::GetWatchListResponse)](../../models/operations/getwatchlistresponse.md)** **[T.nilable(::PlexRubySDK::Operations::GetWatchListResponse)](../../models/operations/getwatchlistresponse.md)**

5
lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb
View File

@@ -14,10 +14,7 @@ module PlexRubySDK
class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# The unique identifier for the client application # 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)
# 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_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
# Include Https entries in the results # Include Https entries in the results
field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } } field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } }

5
lib/plex_ruby_sdk/models/operations/getpin_request.rb
View File

@@ -14,10 +14,7 @@ module PlexRubySDK
class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# The unique identifier for the client application # 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)
# 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_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 } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }

5
lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb
View File

@@ -16,10 +16,7 @@ module PlexRubySDK
# The PinID to retrieve an access token for # The PinID to retrieve an access token for
field :pin_id, ::Integer, { 'path_param': { 'field_name': 'pinID', 'style': 'simple', 'explode': false } } field :pin_id, ::Integer, { 'path_param': { 'field_name': 'pinID', 'style': 'simple', 'explode': false } }
# The unique identifier for the client application # 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)
# 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_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 } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }

5
lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb
View File

@@ -14,10 +14,7 @@ module PlexRubySDK
class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# The unique identifier for the client application # 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)
# 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_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 } } field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }

6
lib/plex_ruby_sdk/sdkconfiguration.rb
View File

@@ -42,9 +42,9 @@ module PlexRubySDK
@globals = globals.nil? ? {} : globals @globals = globals.nil? ? {} : globals
@language = 'ruby' @language = 'ruby'
@openapi_doc_version = '0.0.3' @openapi_doc_version = '0.0.3'
@sdk_version = '0.4.5' @sdk_version = '0.4.6'
@gen_version = '2.426.2' @gen_version = '2.428.1'
@user_agent = 'speakeasy-sdk/ruby 0.4.5 2.426.2 0.0.3 plex_ruby_sdk' @user_agent = 'speakeasy-sdk/ruby 0.4.6 2.428.1 0.0.3 plex_ruby_sdk'
end end
sig { returns([String, T::Hash[Symbol, String]]) } sig { returns([String, T::Hash[Symbol, String]]) }

2
plex_ruby_sdk.gemspec
View File

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
Gem::Specification.new do |s| Gem::Specification.new do |s|
s.name = 'plex_ruby_sdk' s.name = 'plex_ruby_sdk'
s.version = '0.4.5' s.version = '0.4.6'
s.platform = Gem::Platform::RUBY s.platform = Gem::Platform::RUBY
s.licenses = ['Apache-2.0'] s.licenses = ['Apache-2.0']
s.summary = '' s.summary = ''