plexruby
SDK Installation
gem install specific_install
gem specific_install https://github.com/LukeHagar/plexruby
SDK Example Usage
Example
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "<value>",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_server_capabilities()
if ! res.two_hundred_application_json_object.nil?
# handle response
end
Available Resources and Operations
Server
- get_server_capabilities - Server Capabilities
- get_server_preferences - Get Server Preferences
- get_available_clients - Get Available Clients
- get_devices - Get Devices
- get_server_identity - Get Server Identity
- get_my_plex_account - Get MyPlex Account
- get_resized_photo - Get a Resized Photo
- get_server_list - Get Server List
Media
- mark_played - Mark Media Played
- mark_unplayed - Mark Media Unplayed
- update_play_progress - Update Media Play Progress
Video
- get_timeline - Get the timeline for a media item
- start_universal_transcode - Start Universal Transcode
Activities
- get_server_activities - Get Server Activities
- cancel_server_activities - Cancel Server Activities
Butler
- get_butler_tasks - Get Butler tasks
- start_all_tasks - Start all Butler tasks
- stop_all_tasks - Stop all Butler tasks
- start_task - Start a single Butler task
- stop_task - Stop a single Butler task
Hubs
- get_global_hubs - Get Global Hubs
- get_library_hubs - Get library specific hubs
Search
- perform_search - Perform a search
- perform_voice_search - Perform a voice search
- get_search_results - Get Search Results
Library
- get_file_hash - Get Hash Value
- get_recently_added - Get Recently Added
- get_libraries - Get All Libraries
- get_library - Get Library Details
- delete_library - Delete Library Section
- get_library_items - Get Library Items
- refresh_library - Refresh Library
- search_library - Search Library
- get_metadata - Get Items Metadata
- get_metadata_children - Get Items Children
- get_on_deck - Get On Deck
Log
- log_line - Logging a single line message.
- log_multi_line - Logging a multi-line message
- enable_paper_trail - Enabling Papertrail
Plex
Playlists
- create_playlist - Create a Playlist
- get_playlists - Get All Playlists
- get_playlist - Retrieve Playlist
- delete_playlist - Deletes a Playlist
- update_playlist - Update a Playlist
- get_playlist_contents - Retrieve Playlist Contents
- clear_playlist_contents - Delete Playlist Contents
- add_playlist_contents - Adding to a Playlist
- upload_playlist - Upload Playlist
Authentication
- get_transient_token - Get a Transient Token.
- get_source_connection_information - Get Source Connection Information
Statistics
- get_statistics - Get Media Statistics
Sessions
- get_sessions - Get Active Sessions
- get_session_history - Get Session History
- get_transcode_sessions - Get Transcode Sessions
- stop_transcode_session - Stop a Transcode Session
Updater
- get_update_status - Querying status of updates
- check_for_updates - Checking for updates
- apply_updates - Apply Updates
Server Selection
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | {protocol}://{ip}:{port} |
protocol (default is http), ip (default is 10.10.10.47), port (default is 32400) |
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
protocol: ::OpenApiSDK::ServerVariables::ServerProtocolip: ::Stringport: ::String
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "<value>",
)
res = s.plex.get_pin(server_url: "https://plex.tv/api/v2", strong=false, x_plex_client_identifier="<value>")
if ! res.two_hundred_application_json_object.nil?
# handle response
end
Global Parameters
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set X-Plex-Client-Identifier to "<value>" at SDK initialization and then you do not have to pass the same value on calls to operations like get_pin. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
Available Globals
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
| Name | Type | Required | Description |
|---|---|---|---|
| x_plex_client_identifier | ::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) | |||
Example
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "<value>",
)
res = s.plex.get_pin(strong=false, x_plex_client_identifier="<value>")
if ! res.two_hundred_application_json_object.nil?
# handle response
end
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!