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

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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 <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 |
| `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 |
| `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 <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 |
| `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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

@@ -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)**

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

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