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.459.2

Browse Source
This commit is contained in:
speakeasybot
2024-12-21 00:08:49 +00:00
parent 076a205a23
commit 3a16a0c415
83 changed files with 603 additions and 972 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
ruby:
version: 0.5.1
version: 0.6.0
author: LukeHagar
description: Ruby Client SDK Generated by Speakeasy
imports:

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.438.3
speakeasyVersion: 1.459.2
sources:
my-source:
sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:37c6bfb15f4154eb89b112465107f20757411f22bd1cc7d0a04335df7127fcb4
sourceBlobDigest: sha256:290473ebc909cada80ff428c685b897f4621cf121397e1417355e06d334e7206
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
tags:
- latest
- main
- speakeasy-sdk-regen-1734739663
targets:
plexruby:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:37c6bfb15f4154eb89b112465107f20757411f22bd1cc7d0a04335df7127fcb4
sourceBlobDigest: sha256:290473ebc909cada80ff428c685b897f4621cf121397e1417355e06d334e7206
sourceRevisionDigest: sha256:ccba0c42f1644923e2209e28da7a78195a843e48da1aeaaedbf8759f1a8a0fe0
sourceBlobDigest: sha256:b362c110ef633288220a55ab50627374b996c64f2d9b8e020944e84ea2840332
codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:4a482cfce20312f3cf8a64ed2b972b1d6cc8ac39eddc94f17fec772bad9a1feb
codeSamplesRevisionDigest: sha256:865d22276b114cf13d16b3de3771e9a73031e4dc8e3fa15ab86de70e62cdaba9
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

93
Gemfile.lock
View File

@@ -1,46 +1,48 @@
PATH
remote: .
specs:
plex_ruby_sdk (0.5.1)
plex_ruby_sdk (0.6.0)
faraday
faraday-multipart
rack
rake
sorbet
sorbet-runtime
GEM
remote: https://rubygems.org/
specs:
ast (2.4.2)
erubi (1.12.0)
faraday (2.9.0)
faraday-net_http (>= 2.0, < 3.2)
erubi (1.13.0)
faraday (2.12.1)
faraday-net_http (>= 2.0, < 3.5)
json
logger
faraday-multipart (1.0.4)
multipart-post (~> 2)
faraday-net_http (3.1.0)
net-http
json (2.7.1)
faraday-net_http (3.4.0)
net-http (>= 0.5.0)
json (2.8.2)
language_server-protocol (3.17.0.3)
minitest (5.22.2)
multipart-post (2.4.0)
net-http (0.4.1)
logger (1.6.1)
minitest (5.25.2)
multipart-post (2.4.1)
net-http (0.5.0)
uri
netrc (0.11.0)
parallel (1.24.0)
parser (3.3.0.5)
parallel (1.26.3)
parser (3.3.6.0)
ast (~> 2.4.1)
racc
prettier_print (1.2.1)
prism (0.21.0)
racc (1.7.3)
rack (3.0.9)
prism (0.27.0)
racc (1.8.1)
rack (3.1.8)
rainbow (3.1.1)
rake (13.1.0)
rbi (0.1.8)
prism (>= 0.18.0, < 0.22)
rake (13.2.1)
rbi (0.1.12)
prism (>= 0.18.0, < 0.28)
sorbet-runtime (>= 0.5.9204)
regexp_parser (2.9.0)
rexml (3.2.6)
regexp_parser (2.9.2)
rexml (3.3.9)
rubocop (1.60.2)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
@@ -52,51 +54,52 @@ GEM
rubocop-ast (>= 1.30.0, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.30.0)
parser (>= 3.2.1.0)
rubocop-ast (1.36.1)
parser (>= 3.3.1.0)
ruby-progressbar (1.13.0)
sorbet (0.5.11287)
sorbet-static (= 0.5.11287)
sorbet-runtime (0.5.11287)
sorbet-static (0.5.11287-aarch64-linux)
sorbet-static (0.5.11287-x86_64-linux)
sorbet-static-and-runtime (0.5.11287)
sorbet (= 0.5.11287)
sorbet-runtime (= 0.5.11287)
spoom (1.2.4)
sorbet (0.5.11668)
sorbet-static (= 0.5.11668)
sorbet-runtime (0.5.11668)
sorbet-static (0.5.11668-aarch64-linux)
sorbet-static (0.5.11668-universal-darwin)
sorbet-static (0.5.11668-x86_64-linux)
sorbet-static-and-runtime (0.5.11668)
sorbet (= 0.5.11668)
sorbet-runtime (= 0.5.11668)
spoom (1.3.2)
erubi (>= 1.10.0)
prism (>= 0.19.0)
sorbet-static-and-runtime (>= 0.5.10187)
syntax_tree (>= 6.1.1)
thor (>= 0.19.2)
syntax_tree (6.2.0)
prettier_print (>= 1.2.0)
tapioca (0.12.0)
tapioca (0.13.3)
bundler (>= 2.2.25)
netrc (>= 0.11.0)
parallel (>= 1.21.0)
rbi (>= 0.1.4, < 0.2)
sorbet-static-and-runtime (>= 0.5.10820)
spoom (~> 1.2.0, >= 1.2.0)
sorbet-static-and-runtime (>= 0.5.11087)
spoom (>= 1.2.0)
thor (>= 1.2.0)
yard-sorbet
thor (1.3.0)
unicode-display_width (2.5.0)
uri (0.13.0)
yard (0.9.34)
thor (1.3.2)
unicode-display_width (2.6.0)
uri (1.0.2)
yard (0.9.37)
yard-sorbet (0.8.1)
sorbet-runtime (>= 0.5)
yard (>= 0.9)
PLATFORMS
aarch64-linux
arm64-darwin-23
arm64-darwin-24
x86_64-linux
DEPENDENCIES
minitest
plex_ruby_sdk!
rubocop (~> 1.60.2)
sorbet-runtime
sorbet
tapioca
BUNDLED WITH
2.4.10
2.2.33

31
README.md
View File

@@ -40,11 +40,19 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [plexruby](#plexruby)
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
* [Documentation](#documentation)
* [SDKs](#sdks)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Server Selection](#server-selection)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
@@ -66,13 +74,7 @@ gem install plex_ruby_sdk
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -242,11 +244,6 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
server_url: "https://10.10.10.47:32400",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -270,13 +267,7 @@ The server URL can also be overridden on a per-operation basis, provided a serve
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

10
RELEASES.md
View File

@@ -647,3 +647,13 @@ Based on:
- [ruby v0.5.1] .
### Releases
- [Ruby Gems v0.5.1] https://rubygems.org/gems/plex_ruby_sdk/versions/0.5.1 - .
## 2024-12-21 00:07:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.6.0] .
### Releases
- [Ruby Gems v0.6.0] https://rubygems.org/gems/plex_ruby_sdk/versions/0.6.0 - .

8
USAGE.md
View File

@@ -3,13 +3,7 @@
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

152
codeSamples.yaml
View File

@@ -8,454 +8,454 @@ actions:
x-codeSamples:
- lang: ruby
label: getServerCapabilities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_capabilities()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_capabilities()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/:/prefs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerPreferences
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_preferences()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_preferences()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/:/progress"]["post"]
update:
x-codeSamples:
- lang: ruby
label: updatePlayProgress
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<key>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<key>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/scrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markPlayed
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/timeline"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTimeline
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::PlexRubySDK::Operations::State::PLAYING,\n has_mde: 1.0,\n time: 2000.0,\n duration: 10000.0,\n context: \"home:hub.continueWatching\",\n play_queue_item_id: 1.0,\n play_back_time: 2000.0,\n row: 1.0,\n)\n \nres = s.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::PlexRubySDK::Operations::State::PLAYING,\n has_mde: 1.0,\n time: 2000.0,\n duration: 10000.0,\n context: \"home:hub.continueWatching\",\n play_queue_item_id: 1.0,\n play_back_time: 2000.0,\n row: 1.0,\n)\n \nres = s.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/unscrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markUnplayed
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/activities"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerActivities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.get_server_activities()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.get_server_activities()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: cancelServerActivities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopAllTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getButlerTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.get_butler_tasks()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.get_butler_tasks()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/butler"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startAllTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopTask
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startTask
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/clients"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getAvailableClients
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_available_clients()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_available_clients()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/companions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getCompanionsData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_companions_data()\n\nif ! res.response_bodies.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_companions_data()\n\nif ! res.response_bodies.nil?\n # handle response\nend"
- target: $["paths"]["/devices"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getDevices
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_devices()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_devices()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/friends"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getUserFriends
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_user_friends()\n\nif ! res.friends.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_user_friends()\n\nif ! res.friends.nil?\n # handle response\nend"
- target: $["paths"]["/geoip"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getGeoData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\n\n \nres = s.plex.get_geo_data()\n\nif ! res.geo_data.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\n\n \nres = s.plex.get_geo_data()\n\nif ! res.geo_data.nil?\n # handle response\nend"
- target: $["paths"]["/home"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getHomeData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_home_data()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_home_data()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getGlobalHubs
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: ruby
label: added
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedRequest.new(\n content_directory_id: 470161,\n section_id: 2,\n type: ::PlexRubySDK::Operations::Type::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.hubs.get_recently_added(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedRequest.new(\n content_directory_id: 470161,\n section_id: 2,\n type: ::PlexRubySDK::Operations::Type::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.hubs.get_recently_added(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: performSearch
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"dylan\", section_id=9372.69, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"dylan\", section_id=9372.69, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/search/voice"]["get"]
update:
x-codeSamples:
- lang: ruby
label: performVoiceSearch
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_voice_search(query=\"dead+poop\", section_id=4094.80, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_voice_search(query=\"dead+poop\", section_id=4094.80, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibraryHubs
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_library_hubs(section_id=6728.76, count=639.24, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_library_hubs(section_id=6728.76, count=639.24, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/identity"]["get"]
update:
x-codeSamples:
- lang: ruby
label: identity
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\n\n \nres = s.server.get_server_identity()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\n\n \nres = s.server.get_server_identity()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/all/top"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTopWatchedContent
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TV_SHOW, include_guids=1)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TV_SHOW, include_guids=1)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/hashes"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getFileHash
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: key
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
update:
x-codeSamples:
- lang: ruby
label: image
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetBannerImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_banner_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetBannerImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_banner_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMetadataChildren
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_metadata_children(rating_key=1539.15, include_elements=\"<value>\")\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_metadata_children(rating_key=1539.15, include_elements=\"<value>\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
update:
x-codeSamples:
- lang: ruby
label: image
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetThumbImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_thumb_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetThumbImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_thumb_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getOnDeck
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_on_deck()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_on_deck()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: ruby
label: library
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest.new(\n content_directory_id: 2,\n pinned_content_directory_id: [\n 3,\n 5,\n 7,\n 13,\n 12,\n 1,\n 6,\n 14,\n 2,\n 10,\n 16,\n 17,\n ],\n section_id: 2,\n type: ::PlexRubySDK::Operations::QueryParamType::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::QueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_recently_added_library(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest.new(\n content_directory_id: 2,\n pinned_content_directory_id: [\n 3,\n 5,\n 7,\n 13,\n 12,\n 1,\n 6,\n 14,\n 2,\n 10,\n 16,\n 17,\n ],\n section_id: 2,\n type: ::PlexRubySDK::Operations::QueryParamType::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::QueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_recently_added_library(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: libraries
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(\n query: \"<value>\",\n search_types: [\n ::PlexRubySDK::Operations::SearchTypes::PEOPLE,\n ],\n include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,\n include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,\n)\n \nres = s.library.get_search_all_libraries(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(\n query: \"<value>\",\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n search_types: [\n ::PlexRubySDK::Operations::SearchTypes::PEOPLE,\n ],\n include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,\n include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,\n)\n \nres = s.library.get_search_all_libraries(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"]
update:
x-codeSamples:
- lang: ruby
label: libraries
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_all_libraries()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_all_libraries()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: list
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetWatchListRequest.new(\n filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.watchlist.get_watch_list(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetWatchListRequest.new(\n filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.watchlist.get_watch_list(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: deleteLibrary
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_key=9518)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_key=9518)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: details
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
update:
x-codeSamples:
- lang: ruby
label: metadata
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: library
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::GetSearchLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::GetSearchLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: items
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,\n type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType::TV_SHOW,\n section_key: 9518,\n include_meta: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,\n type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType::TV_SHOW,\n section_key: 9518,\n include_meta: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/log"]["get"]
update:
x-codeSamples:
- lang: ruby
label: logLine
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log"]["post"]
update:
x-codeSamples:
- lang: ruby
label: logMultiLine
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = \"level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman\"\n \nres = s.log.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = \"level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman\"\n \nres = s.log.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log/networked"]["get"]
update:
x-codeSamples:
- lang: ruby
label: enablePaperTrail
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/media/providers"]["get"]
update:
x-codeSamples:
- lang: ruby
label: providers
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_media_providers(x_plex_token=\"CV5xoxjTpFKUzBTShsaf\")\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_media_providers(x_plex_token=\"CV5xoxjTpFKUzBTShsaf\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/myplex/account"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMyPlexAccount
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_my_plex_account()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_my_plex_account()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/photo/:/transcode"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getResizedPhoto
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ONE,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ONE,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/pins"]["post"]
update:
x-codeSamples:
- lang: ruby
label: getPin
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\n\n\nreq = ::PlexRubySDK::Operations::GetPinRequest.new()\n \nres = s.plex.get_pin(req)\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\n\n\nreq = ::PlexRubySDK::Operations::GetPinRequest.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n device_nickname: \"Roku 3\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n)\n \nres = s.plex.get_pin(req)\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
- target: $["paths"]["/pins/{pinID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTokenByPinId
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\n\n\nreq = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(\n pin_id: 408895,\n)\n \nres = s.plex.get_token_by_pin_id(req)\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\n\n\nreq = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(\n pin_id: 408895,\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n device_nickname: \"Roku 3\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n)\n \nres = s.plex.get_token_by_pin_id(req)\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
- target: $["paths"]["/playlists"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylists
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists"]["post"]
update:
x-codeSamples:
- lang: ruby
label: createPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,\n smart: ::PlexRubySDK::Operations::Smart::ONE,\n uri: \"https://hoarse-testing.info/\",\n)\n \nres = s.playlists.create_playlist(req)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,\n smart: ::PlexRubySDK::Operations::Smart::ONE,\n uri: \"https://hoarse-testing.info/\",\n)\n \nres = s.playlists.create_playlist(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/upload"]["post"]
update:
x-codeSamples:
- lang: ruby
label: uploadPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::PlexRubySDK::Operations::QueryParamForce::ZERO, section_id=1)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::PlexRubySDK::Operations::QueryParamForce::ZERO, section_id=1)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: deletePlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["put"]
update:
x-codeSamples:
- lang: ruby
label: updatePlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.update_playlist(playlist_id=3915.00, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.update_playlist(playlist_id=3915.00, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: clearPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
update:
x-codeSamples:
- lang: ruby
label: addPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.add_playlist_contents(playlist_id=8502.00, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.add_playlist_contents(playlist_id=8502.00, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/resources"]["get"]
update:
x-codeSamples:
- lang: ruby
label: resources
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_server_resources(include_https=::PlexRubySDK::Operations::IncludeHttps::ENABLE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ENABLE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ENABLE, client_id=\"3381b62b-9ab7-4e37-827b-203e9809eb58\")\n\nif ! res.plex_devices.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_server_resources(client_id=\"3381b62b-9ab7-4e37-827b-203e9809eb58\", include_https=::PlexRubySDK::Operations::IncludeHttps::ENABLE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ENABLE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ENABLE)\n\nif ! res.plex_devices.nil?\n # handle response\nend"
- target: $["paths"]["/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSearchResults
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/security/resources"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSourceConnectionInformation
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/security/token"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTransientToken
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/servers"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerList
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_list()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_list()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/bandwidth"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getBandwidthStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/media"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/resources"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getResourcesStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_resources_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_resources_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessions
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions/history/all"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessionHistory
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/transcode/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTranscodeSessions
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_transcode_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_transcode_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopTranscodeSession
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/apply"]["put"]
update:
x-codeSamples:
- lang: ruby
label: applyUpdates
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/check"]["put"]
update:
x-codeSamples:
- lang: ruby
label: checkForUpdates
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/status"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getUpdateStatus
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.object.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/user"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTokenDetails
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_token_details()\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_token_details()\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
- target: $["paths"]["/users/signin"]["post"]
update:
x-codeSamples:
- lang: ruby
label: data
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\n\n\nreq = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(\n request_body: ::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n ),\n)\n \nres = s.authentication.post_users_sign_in_data(req)\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\n\n\nreq = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n device_nickname: \"Roku 3\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n request_body: ::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n ),\n)\n \nres = s.authentication.post_users_sign_in_data(req)\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
update:
x-codeSamples:
- lang: ruby
label: startUniversalTranscode
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n client_name: \"Plex for Roku\",\n client_version: \"2.4.1\",\n platform: \"Roku\",\n device_nickname: \"Roku 3\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"

2
docs/models/operations/getlibraryitemsmetadata.md
View File

@@ -24,7 +24,7 @@
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsFlattenSeasons)](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering)](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering)](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

2
docs/models/operations/getlibraryitemsqueryparamtype.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

14
docs/models/operations/getlibraryitemsshowordering.md
View File

@@ -3,18 +3,18 @@
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------- | ------------- |
| --------------- | --------------- |
| `NONE` | None |
| `TMDB_AIRING` | tmdbAiring |
| `AIRED` | aired |
| `DVD` | dvd |
| `ABSOLUTE` | absolute |
| `TVDB_AIRING` | tvdbAiring |
| `TVDB_DVD` | tvdbDvd |
| `TVDB_ABSOLUTE` | tvdbAbsolute |

5
docs/models/operations/getmetadatabyratingkeymetadata.md
View File

@@ -14,6 +14,11 @@
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.2 |

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

@@ -6,7 +6,7 @@
| 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/> | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

2
docs/models/operations/getplaylistcontentsqueryparamtype.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

2
docs/models/operations/getrecentlyaddedmetadata.md
View File

@@ -24,7 +24,7 @@
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

2
docs/models/operations/getsearchalllibrariesmetadata.md
View File

@@ -24,7 +24,7 @@
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesFlattenSeasons)](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesShowOrdering)](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesShowOrdering)](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

2
docs/models/operations/getsearchalllibrariesrequest.md
View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `query` | *::String* | :heavy_check_mark: | The search query term. | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *T.nilable(::Integer)* | :heavy_minus_sign: | Limit the number of results returned. | |
| `search_types` | T::Array<[::PlexRubySDK::Operations::SearchTypes](../../models/operations/searchtypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `include_collections` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections)](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |

14
docs/models/operations/getsearchalllibrariesshowordering.md
View File

@@ -3,18 +3,18 @@
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------- | ------------- |
| --------------- | --------------- |
| `NONE` | None |
| `TMDB_AIRING` | tmdbAiring |
| `AIRED` | aired |
| `DVD` | dvd |
| `ABSOLUTE` | absolute |
| `TVDB_AIRING` | tvdbAiring |
| `TVDB_DVD` | tvdbDvd |
| `TVDB_ABSOLUTE` | tvdbAbsolute |

2
docs/models/operations/getsearchlibraryqueryparamtype.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `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_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: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

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

@@ -6,7 +6,7 @@
| 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: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

2
docs/models/operations/gettopwatchedcontentqueryparamtype.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

2
docs/models/operations/queryparamtype.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

14
docs/models/operations/showordering.md
View File

@@ -3,18 +3,18 @@
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
tvdbAiring = TheTVDB (Aired),
tvdbDvd = TheTVDB (DVD),
tvdbAbsolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------- | ------------- |
| --------------- | --------------- |
| `NONE` | None |
| `TMDB_AIRING` | tmdbAiring |
| `AIRED` | aired |
| `DVD` | dvd |
| `ABSOLUTE` | absolute |
| `TVDB_AIRING` | tvdbAiring |
| `TVDB_DVD` | tvdbDvd |
| `TVDB_ABSOLUTE` | tvdbAbsolute |

1
docs/models/operations/tag.md
View File

@@ -26,3 +26,4 @@ A key representing a specific tag within the section.
| `RESOLUTION` | resolution |
| `FIRST_CHARACTER` | firstCharacter |
| `FOLDER` | folder |
| `ALBUMS` | albums |

2
docs/models/operations/type.md
View File

@@ -18,3 +18,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `SEASON` | 3 |
| `EPISODE` | 4 |
| `AUDIO` | 8 |
| `ALBUM` | 9 |
| `TRACK` | 10 |

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

@@ -27,13 +27,7 @@ Get Server Activities
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -65,13 +59,7 @@ Cancel Server Activities
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -24,13 +24,7 @@ This endpoint provides the caller with a temporary token with the same access le
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -71,13 +65,7 @@ Note: requires Plex Media Server >= 1.15.4.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -115,13 +103,7 @@ Get the User data from the provided X-Plex-Token
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -159,16 +141,15 @@ Sign in user with username and password and return user data with Plex authentic
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
device_nickname: "Roku 3",
client_version: "2.4.1",
platform: "Roku",
request_body: ::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(
login: "username@email.com",
password: "password123",

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

@@ -24,13 +24,7 @@ Returns a list of butler tasks
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -67,13 +61,7 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -106,13 +94,7 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -149,13 +131,7 @@ This endpoint will attempt to start a single Butler task that is enabled in the
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -194,13 +170,7 @@ This endpoint will stop a currently running task by name, or remove it from the
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -22,13 +22,7 @@ Get Global Hubs filtered by the parameters provided.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -68,13 +62,7 @@ This endpoint will return the recently added content.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -122,13 +110,7 @@ This endpoint will return a list of library specific hubs
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -32,13 +32,7 @@ This resource returns hash values for local files
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -78,13 +72,7 @@ This endpoint will return the recently added content.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -151,13 +139,7 @@ This allows a client to provide a rich interface around the media (e.g. allow so
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -228,13 +210,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -273,13 +249,7 @@ Delete a library using a specific section id
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -329,6 +299,7 @@ Fetches details from a specific section of the library identified by a section k
- `resolution`: Items categorized by resolution.
- `firstCharacter`: Items categorized by the first letter.
- `folder`: Items categorized by folder.
- `albums`: Items categorized by album.
### Example Usage
@@ -337,13 +308,7 @@ Fetches details from a specific section of the library identified by a section k
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -392,13 +357,7 @@ This endpoint Refreshes all the Metadata of the library.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -455,13 +414,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -501,13 +454,7 @@ Search the provided query across all library sections, or a single section, and
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -517,6 +464,7 @@ s.config_security(
req = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(
query: "<value>",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
search_types: [
::PlexRubySDK::Operations::SearchTypes::PEOPLE,
],
@@ -555,13 +503,7 @@ This endpoint will return the metadata of a library item specified with the rati
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -600,13 +542,7 @@ This endpoint will return the children of of a library item specified with the r
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -646,13 +582,7 @@ This endpoint will return the top watched content from libraries of a certain ty
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -692,13 +622,7 @@ This endpoint will return the on deck content.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -23,13 +23,7 @@ This endpoint will write a single-line log message, including a level and source
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -90,13 +84,7 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -139,13 +127,7 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -24,13 +24,7 @@ This will mark the provided media key as Played.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -68,13 +62,7 @@ This will mark the provided media key as Unplayed.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -113,13 +101,7 @@ This API command can be used to update the play progress of a media item.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -159,13 +141,7 @@ Gets the banner image of the media item
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -212,13 +188,7 @@ Gets the thumbnail image of the media item
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -34,13 +34,7 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -85,13 +79,7 @@ Get All Playlists given the specified filters.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -132,13 +120,7 @@ Smart playlist details contain the `content` attribute. This is the content URI
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -177,13 +159,7 @@ This endpoint will delete a playlist
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -222,13 +198,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -272,13 +242,7 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -318,13 +282,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -364,13 +322,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -411,13 +363,7 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -26,13 +26,7 @@ Get Companions Data
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -70,13 +64,7 @@ Get friends of provided auth token.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -114,13 +102,7 @@ Returns the geolocation and locale data of the caller
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
res = s.plex.get_geo_data()
@@ -153,13 +135,7 @@ Retrieves the home data for the authenticated user, including details like home
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -191,13 +167,7 @@ Get Plex server access tokens and server connections
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -205,7 +175,7 @@ s.config_security(
)
res = s.plex.get_server_resources(include_https=::PlexRubySDK::Operations::IncludeHttps::ENABLE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ENABLE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ENABLE, client_id="3381b62b-9ab7-4e37-827b-203e9809eb58")
res = s.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58", include_https=::PlexRubySDK::Operations::IncludeHttps::ENABLE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ENABLE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ENABLE)
if ! res.plex_devices.nil?
# handle response
@@ -217,10 +187,10 @@ end
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `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_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: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
@@ -239,17 +209,17 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetPinRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
device_nickname: "Roku 3",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
req = ::PlexRubySDK::Operations::GetPinRequest.new()
res = s.plex.get_pin(req)
if ! res.auth_pin_container.nil?
@@ -281,17 +251,16 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(
pin_id: 408895,
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
device_nickname: "Roku 3",
client_version: "2.4.1",
platform: "Roku",
)
res = s.plex.get_token_by_pin_id(req)

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

@@ -26,3 +26,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
### Available Operations

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

@@ -34,13 +34,7 @@ This request is intended to be very fast, and called as the user types.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -84,13 +78,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -130,13 +118,7 @@ This will search the database for the string provided.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -28,13 +28,7 @@ Get Server Capabilities
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -66,13 +60,7 @@ Get Server Preferences
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -104,13 +92,7 @@ Get Available Clients
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -142,13 +124,7 @@ Get Devices
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -180,13 +156,7 @@ This request is useful to determine if the server is online or offline
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
res = s.server.get_server_identity()
@@ -213,13 +183,7 @@ Returns MyPlex Account Information
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -252,13 +216,7 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -306,13 +264,7 @@ Retrieves media providers and their features from the Plex server.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -350,13 +302,7 @@ Get Server List
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -23,13 +23,7 @@ This will retrieve the "Now Playing" Information of the PMS.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -61,13 +55,7 @@ This will Retrieve a listing of all history views.
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -108,13 +96,7 @@ Get Transcode Sessions
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -146,13 +128,7 @@ Stop a Transcode Session
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -22,13 +22,7 @@ This will return the media statistics for the server
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -66,13 +60,7 @@ This will return the resources for the server
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -110,13 +98,7 @@ This will return the bandwidth statistics for the server
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -23,13 +23,7 @@ Querying status of updates
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -61,13 +55,7 @@ Checking for updates
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -106,13 +94,7 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -21,13 +21,7 @@ Get the timeline for a media item
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
@@ -78,13 +72,7 @@ Begin a Universal Transcode Session
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

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

@@ -20,13 +20,7 @@ Get User Watchlist
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",

5
lib/plex_ruby_sdk/activities.rb
View File

@@ -63,6 +63,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -81,8 +82,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::CancelServerActivitiesRequest,
base_url,
'/activities/{activityUUID}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -110,6 +110,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

10
lib/plex_ruby_sdk/authentication.rb
View File

@@ -44,7 +44,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/security/token"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTransientTokenRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTransientTokenRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -71,6 +71,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -89,7 +90,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/security/resources"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSourceConnectionInformationRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSourceConnectionInformationRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -116,6 +117,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -158,6 +160,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -170,7 +173,7 @@ module PlexRubySDK
})
base_url = server_url if !server_url.nil?
url = "#{base_url}/users/signin"
headers = Utils.get_headers(request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :form)
headers['content-type'] = req_content_type
headers['Accept'] = 'application/json'
@@ -208,6 +211,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

11
lib/plex_ruby_sdk/butler.rb
View File

@@ -57,6 +57,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -99,6 +100,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -137,6 +139,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -160,8 +163,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::StartTaskRequest,
base_url,
'/butler/{taskName}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -189,6 +191,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -208,8 +211,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::StopTaskRequest,
base_url,
'/butler/{taskName}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -237,6 +239,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

12
lib/plex_ruby_sdk/hubs.rb
View File

@@ -33,7 +33,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/hubs"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetGlobalHubsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetGlobalHubsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -64,6 +64,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -77,7 +78,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/hubs/home/recentlyAdded"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRecentlyAddedRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRecentlyAddedRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -99,6 +100,7 @@ module PlexRubySDK
end
elsif [400, 401].include?(r.status)
end
res
end
@@ -120,11 +122,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetLibraryHubsRequest,
base_url,
'/hubs/sections/{sectionId}',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryHubsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryHubsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -155,6 +156,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

55
lib/plex_ruby_sdk/library.rb
View File

@@ -33,7 +33,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/library/hashes"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetFileHashRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetFileHashRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -60,6 +60,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -73,7 +74,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/library/recentlyAdded"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -104,6 +105,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -151,6 +153,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -209,11 +212,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetLibraryDetailsRequest,
base_url,
'/library/sections/{sectionKey}',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryDetailsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryDetailsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -244,6 +246,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -262,8 +265,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::DeleteLibraryRequest,
base_url,
'/library/sections/{sectionKey}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -291,6 +293,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -318,6 +321,7 @@ module PlexRubySDK
# - `resolution`: Items categorized by resolution.
# - `firstCharacter`: Items categorized by the first letter.
# - `folder`: Items categorized by folder.
# - `albums`: Items categorized by album.
#
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
@@ -325,11 +329,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetLibraryItemsRequest,
base_url,
'/library/sections/{sectionKey}/{tag}',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryItemsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetLibraryItemsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -360,6 +363,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -380,11 +384,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetRefreshLibraryMetadataRequest,
base_url,
'/library/sections/{sectionKey}/refresh',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRefreshLibraryMetadataRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetRefreshLibraryMetadataRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -411,6 +414,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -448,11 +452,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetSearchLibraryRequest,
base_url,
'/library/sections/{sectionKey}/search',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchLibraryRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchLibraryRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -483,6 +486,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -495,8 +499,8 @@ module PlexRubySDK
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = "#{base_url}/library/search"
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchAllLibrariesRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchAllLibrariesRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -527,6 +531,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -546,8 +551,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetMetaDataByRatingKeyRequest,
base_url,
'/library/metadata/{ratingKey}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -579,6 +583,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -599,11 +604,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetMetadataChildrenRequest,
base_url,
'/library/metadata/{ratingKey}/children',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetMetadataChildrenRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetMetadataChildrenRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -634,6 +638,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -652,7 +657,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/library/all/top"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTopWatchedContentRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTopWatchedContentRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -683,6 +688,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -725,6 +731,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

5
lib/plex_ruby_sdk/log.rb
View File

@@ -35,7 +35,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/log"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::LogLineRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::LogLineRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -62,6 +62,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -130,6 +131,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -168,6 +170,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

27
lib/plex_ruby_sdk/media.rb
View File

@@ -32,7 +32,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/scrobble"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::MarkPlayedRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::MarkPlayedRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -59,6 +59,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -75,7 +76,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/unscrobble"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::MarkUnplayedRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::MarkUnplayedRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -102,6 +103,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -121,7 +123,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/progress"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UpdatePlayProgressRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UpdatePlayProgressRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -148,6 +150,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -162,11 +165,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetBannerImageRequest,
base_url,
'/library/metadata/{ratingKey}/banner',
request,
@sdk_configuration.globals
request
)
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetBannerImageRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetBannerImageRequest, request)
headers['Accept'] = 'application/json;q=1, image/jpeg;q=0'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -184,7 +186,6 @@ module PlexRubySDK
if r.status == 200
res.headers = r.headers
res.bytes = r.env.response_body if Utils.match_content_type(content_type, 'image/jpeg')
elsif r.status == 400
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetBannerImageBadRequest)
@@ -196,6 +197,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -210,11 +212,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetThumbImageRequest,
base_url,
'/library/metadata/{ratingKey}/thumb',
request,
@sdk_configuration.globals
request
)
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetThumbImageRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetThumbImageRequest, request)
headers['Accept'] = 'application/json;q=1, image/jpeg;q=0'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -232,7 +233,6 @@ module PlexRubySDK
if r.status == 200
res.headers = r.headers
res.bytes = r.env.response_body if Utils.match_content_type(content_type, 'image/jpeg')
elsif r.status == 400
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetThumbImageBadRequest)
@@ -244,6 +244,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

6
lib/plex_ruby_sdk/models/operations/get_library_items_metadata.rb
View File

@@ -136,9 +136,9 @@ module PlexRubySDK
# Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
field :show_ordering, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('showOrdering'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering, true) } }

2
lib/plex_ruby_sdk/models/operations/get_library_items_queryparam_type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

12
lib/plex_ruby_sdk/models/operations/get_library_items_showordering.rb
View File

@@ -10,17 +10,17 @@ module PlexRubySDK
# GetLibraryItemsShowOrdering - Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
class GetLibraryItemsShowOrdering < T::Enum
enums do
NONE = new('None')
TMDB_AIRING = new('tmdbAiring')
AIRED = new('aired')
DVD = new('dvd')
ABSOLUTE = new('absolute')
TVDB_AIRING = new('tvdbAiring')
TVDB_DVD = new('tvdbDvd')
TVDB_ABSOLUTE = new('tvdbAbsolute')
end
end
end

19
lib/plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_metadata.rb
View File

@@ -29,12 +29,16 @@ module PlexRubySDK
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :genre, T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyGenre]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Genre') } }
# The name of the album artist for the track when audio, and the name of the TV show for the episode when video.
field :grandparent_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentTitle') } }
field :guid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('guid') } }
field :guids, T.nilable(T::Array[::PlexRubySDK::Operations::Guids]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Guid') } }
field :has_premium_primary_extra, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasPremiumPrimaryExtra') } }
# The index starting from 0 of this media item in the MetaData array.
field :index, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('index') } }
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
@@ -47,6 +51,12 @@ module PlexRubySDK
field :media, T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMedia]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Media') } }
field :originally_available_at, T.nilable(::Date), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('originallyAvailableAt'), 'decoder': Utils.date_from_iso_format(true) } }
# The orginal untranslated name of the media item when non-english.
field :original_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('originalTitle') } }
# The parent index starting from 0 of this media item in the parent MetaData array.
field :parent_index, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentIndex') } }
# The name of the album for the track when audio, and the name of the season for the episode when TV show.
field :parent_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentTitle') } }
field :producer, T.nilable(T::Array[::PlexRubySDK::Operations::Producer]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Producer') } }
@@ -79,8 +89,8 @@ module PlexRubySDK
field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('year') } }
sig { params(added_at: T.nilable(::Integer), art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyCountry]), director: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyDirector]), duration: T.nilable(::Integer), genre: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyGenre]), guid: T.nilable(::String), guids: T.nilable(T::Array[::PlexRubySDK::Operations::Guids]), has_premium_primary_extra: T.nilable(::String), key: T.nilable(::String), library_section_id: T.nilable(::Integer), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), media: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMedia]), originally_available_at: T.nilable(::Date), producer: T.nilable(T::Array[::PlexRubySDK::Operations::Producer]), rating: T.nilable(::Float), rating_image: T.nilable(::String), rating_key: T.nilable(::String), ratings: T.nilable(T::Array[::PlexRubySDK::Operations::Ratings]), role: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyRole]), studio: T.nilable(::String), summary: T.nilable(::String), tagline: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String), type: T.nilable(::String), updated_at: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyWriter]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, art: nil, audience_rating: nil, audience_rating_image: nil, content_rating: nil, country: nil, director: nil, duration: nil, genre: nil, guid: nil, guids: nil, has_premium_primary_extra: nil, key: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, media: nil, originally_available_at: nil, producer: nil, rating: nil, rating_image: nil, rating_key: nil, ratings: nil, role: nil, studio: nil, summary: nil, tagline: nil, thumb: nil, title: nil, type: nil, updated_at: nil, writer: nil, year: nil)
sig { params(added_at: T.nilable(::Integer), art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyCountry]), director: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyDirector]), duration: T.nilable(::Integer), genre: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyGenre]), grandparent_title: T.nilable(::String), guid: T.nilable(::String), guids: T.nilable(T::Array[::PlexRubySDK::Operations::Guids]), has_premium_primary_extra: T.nilable(::String), index: T.nilable(::Integer), key: T.nilable(::String), library_section_id: T.nilable(::Integer), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), media: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMedia]), originally_available_at: T.nilable(::Date), original_title: T.nilable(::String), parent_index: T.nilable(::Integer), parent_title: T.nilable(::String), producer: T.nilable(T::Array[::PlexRubySDK::Operations::Producer]), rating: T.nilable(::Float), rating_image: T.nilable(::String), rating_key: T.nilable(::String), ratings: T.nilable(T::Array[::PlexRubySDK::Operations::Ratings]), role: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyRole]), studio: T.nilable(::String), summary: T.nilable(::String), tagline: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String), type: T.nilable(::String), updated_at: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyWriter]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, art: nil, audience_rating: nil, audience_rating_image: nil, content_rating: nil, country: nil, director: nil, duration: nil, genre: nil, grandparent_title: nil, guid: nil, guids: nil, has_premium_primary_extra: nil, index: nil, key: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, media: nil, originally_available_at: nil, original_title: nil, parent_index: nil, parent_title: nil, producer: nil, rating: nil, rating_image: nil, rating_key: nil, ratings: nil, role: nil, studio: nil, summary: nil, tagline: nil, thumb: nil, title: nil, type: nil, updated_at: nil, writer: nil, year: nil)
@added_at = added_at
@art = art
@audience_rating = audience_rating
@@ -90,15 +100,20 @@ module PlexRubySDK
@director = director
@duration = duration
@genre = genre
@grandparent_title = grandparent_title
@guid = guid
@guids = guids
@has_premium_primary_extra = has_premium_primary_extra
@index = index
@key = key
@library_section_id = library_section_id
@library_section_key = library_section_key
@library_section_title = library_section_title
@media = media
@originally_available_at = originally_available_at
@original_title = original_title
@parent_index = parent_index
@parent_title = parent_title
@producer = producer
@rating = rating
@rating_image = rating_image

6
lib/plex_ruby_sdk/models/operations/get_recently_added_metadata.rb
View File

@@ -136,9 +136,9 @@ module PlexRubySDK
# Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
field :show_ordering, T.nilable(::PlexRubySDK::Operations::ShowOrdering), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('showOrdering'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::ShowOrdering, true) } }

6
lib/plex_ruby_sdk/models/operations/get_search_all_libraries_metadata.rb
View File

@@ -136,9 +136,9 @@ module PlexRubySDK
# Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
field :show_ordering, T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesShowOrdering), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('showOrdering'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetSearchAllLibrariesShowOrdering, true) } }

10
lib/plex_ruby_sdk/models/operations/get_search_all_libraries_request.rb
View File

@@ -11,10 +11,10 @@ module PlexRubySDK
class GetSearchAllLibrariesRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, ::String, { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# The search query term.
field :query, ::String, { 'query_param': { 'field_name': 'query', 'style': 'form', 'explode': true } }
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# Whether to include collections in the search results.
field :include_collections, T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections), { 'query_param': { 'field_name': 'includeCollections', 'style': 'form', 'explode': true } }
# Whether to include external media in the search results.
@@ -26,10 +26,10 @@ module PlexRubySDK
field :search_types, T.nilable(T::Array[::PlexRubySDK::Operations::SearchTypes]), { 'query_param': { 'field_name': 'searchTypes', 'style': 'form', 'explode': false } }
sig { params(query: ::String, client_id: T.nilable(::String), include_collections: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections), include_external_media: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia), limit: T.nilable(::Integer), search_types: T.nilable(T::Array[::PlexRubySDK::Operations::SearchTypes])).void }
def initialize(query: nil, client_id: nil, include_collections: nil, include_external_media: nil, limit: nil, search_types: nil)
@query = query
sig { params(client_id: ::String, query: ::String, include_collections: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections), include_external_media: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia), limit: T.nilable(::Integer), search_types: T.nilable(T::Array[::PlexRubySDK::Operations::SearchTypes])).void }
def initialize(client_id: nil, query: nil, include_collections: nil, include_external_media: nil, limit: nil, search_types: nil)
@client_id = client_id
@query = query
@include_collections = include_collections
@include_external_media = include_external_media
@limit = limit

12
lib/plex_ruby_sdk/models/operations/get_search_all_libraries_showordering.rb
View File

@@ -10,17 +10,17 @@ module PlexRubySDK
# GetSearchAllLibrariesShowOrdering - Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
class GetSearchAllLibrariesShowOrdering < T::Enum
enums do
NONE = new('None')
TMDB_AIRING = new('tmdbAiring')
AIRED = new('aired')
DVD = new('dvd')
ABSOLUTE = new('absolute')
TVDB_AIRING = new('tvdbAiring')
TVDB_DVD = new('tvdbDvd')
TVDB_ABSOLUTE = new('tvdbAbsolute')
end
end
end

2
lib/plex_ruby_sdk/models/operations/get_search_library_queryparam_type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

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

@@ -15,7 +15,7 @@ module PlexRubySDK
extend T::Sig
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
field :client_id, ::String, { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# Include Https entries in the results
field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } }
# Include IPv6 entries in the results
@@ -26,7 +26,7 @@ module PlexRubySDK
field :include_relay, T.nilable(::PlexRubySDK::Operations::IncludeRelay), { 'query_param': { 'field_name': 'includeRelay', 'style': 'form', 'explode': true } }
sig { params(client_id: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay)).void }
sig { params(client_id: ::String, include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay)).void }
def initialize(client_id: nil, include_https: nil, include_i_pv6: nil, include_relay: nil)
@client_id = client_id
@include_https = include_https

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

@@ -15,7 +15,7 @@ module PlexRubySDK
extend T::Sig
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
field :client_id, ::String, { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# The name of the client application. (Plex Web, Plex Media Server, etc.)
field :client_name, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Product', 'style': 'simple', 'explode': false } }
# The version of the client application.
@@ -31,7 +31,7 @@ module PlexRubySDK
field :strong, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'strong', 'style': 'form', 'explode': true } }
sig { params(client_id: T.nilable(::String), client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String), strong: T.nilable(T::Boolean)).void }
sig { params(client_id: ::String, client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String), strong: T.nilable(T::Boolean)).void }
def initialize(client_id: nil, client_name: nil, client_version: nil, device_nickname: nil, platform: nil, strong: nil)
@client_id = client_id
@client_name = client_name

2
lib/plex_ruby_sdk/models/operations/getplaylistcontents_queryparam_type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

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

@@ -14,10 +14,10 @@ module PlexRubySDK
class GetTokenByPinIdRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, ::String, { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# The PinID to retrieve an access token for
field :pin_id, ::Integer, { 'path_param': { 'field_name': 'pinID', 'style': 'simple', 'explode': false } }
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# The name of the client application. (Plex Web, Plex Media Server, etc.)
field :client_name, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Product', 'style': 'simple', 'explode': false } }
# The version of the client application.
@@ -28,10 +28,10 @@ module PlexRubySDK
field :platform, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Platform', 'style': 'simple', 'explode': false } }
sig { params(pin_id: ::Integer, client_id: T.nilable(::String), client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String)).void }
def initialize(pin_id: nil, client_id: nil, client_name: nil, client_version: nil, device_nickname: nil, platform: nil)
@pin_id = pin_id
sig { params(client_id: ::String, pin_id: ::Integer, client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String)).void }
def initialize(client_id: nil, pin_id: nil, client_name: nil, client_version: nil, device_nickname: nil, platform: nil)
@client_id = client_id
@pin_id = pin_id
@client_name = client_name
@client_version = client_version
@device_nickname = device_nickname

2
lib/plex_ruby_sdk/models/operations/gettopwatchedcontent_queryparam_type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

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

@@ -15,7 +15,7 @@ module PlexRubySDK
extend T::Sig
# An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
field :client_id, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
field :client_id, ::String, { 'header': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'simple', 'explode': false } }
# The name of the client application. (Plex Web, Plex Media Server, etc.)
field :client_name, T.nilable(::String), { 'header': { 'field_name': 'X-Plex-Product', 'style': 'simple', 'explode': false } }
# The version of the client application.
@@ -28,7 +28,7 @@ module PlexRubySDK
field :request_body, T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), { 'request': { 'media_type': 'application/x-www-form-urlencoded' } }
sig { params(client_id: T.nilable(::String), client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)).void }
sig { params(client_id: ::String, client_name: T.nilable(::String), client_version: T.nilable(::String), device_nickname: T.nilable(::String), platform: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)).void }
def initialize(client_id: nil, client_name: nil, client_version: nil, device_nickname: nil, platform: nil, request_body: nil)
@client_id = client_id
@client_name = client_name

2
lib/plex_ruby_sdk/models/operations/queryparam_type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

12
lib/plex_ruby_sdk/models/operations/showordering.rb
View File

@@ -10,17 +10,17 @@ module PlexRubySDK
# ShowOrdering - Setting that indicates the episode ordering for the show
# None = Library default,
# tmdbAiring = The Movie Database (Aired),
# aired = TheTVDB (Aired),
# dvd = TheTVDB (DVD),
# absolute = TheTVDB (Absolute)).
# tvdbAiring = TheTVDB (Aired),
# tvdbDvd = TheTVDB (DVD),
# tvdbAbsolute = TheTVDB (Absolute)).
#
class ShowOrdering < T::Enum
enums do
NONE = new('None')
TMDB_AIRING = new('tmdbAiring')
AIRED = new('aired')
DVD = new('dvd')
ABSOLUTE = new('absolute')
TVDB_AIRING = new('tvdbAiring')
TVDB_DVD = new('tvdbDvd')
TVDB_ABSOLUTE = new('tvdbAbsolute')
end
end
end

1
lib/plex_ruby_sdk/models/operations/tag.rb
View File

@@ -29,6 +29,7 @@ module PlexRubySDK
RESOLUTION = new('resolution')
FIRST_CHARACTER = new('firstCharacter')
FOLDER = new('folder')
ALBUMS = new('albums')
end
end
end

2
lib/plex_ruby_sdk/models/operations/type.rb
View File

@@ -21,6 +21,8 @@ module PlexRubySDK
SEASON = new(3)
EPISODE = new(4)
AUDIO = new(8)
ALBUM = new(9)
TRACK = new(10)
end
end
end

39
lib/plex_ruby_sdk/playlists.rb
View File

@@ -34,7 +34,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/playlists"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::CreatePlaylistRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::CreatePlaylistRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -65,6 +65,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -82,7 +83,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/playlists"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPlaylistsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPlaylistsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -113,6 +114,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -133,8 +135,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetPlaylistRequest,
base_url,
'/playlists/{playlistID}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -166,6 +167,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -185,8 +187,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::DeletePlaylistRequest,
base_url,
'/playlists/{playlistID}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -214,6 +215,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -235,11 +237,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::UpdatePlaylistRequest,
base_url,
'/playlists/{playlistID}',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UpdatePlaylistRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UpdatePlaylistRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -266,6 +267,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -289,11 +291,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetPlaylistContentsRequest,
base_url,
'/playlists/{playlistID}/items',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPlaylistContentsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPlaylistContentsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -324,6 +325,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -343,8 +345,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::ClearPlaylistContentsRequest,
base_url,
'/playlists/{playlistID}/items',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -372,6 +373,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -394,11 +396,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::AddPlaylistContentsRequest,
base_url,
'/playlists/{playlistID}/items',
request,
@sdk_configuration.globals
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::AddPlaylistContentsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::AddPlaylistContentsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -429,6 +430,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -448,7 +450,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/playlists/upload"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UploadPlaylistRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::UploadPlaylistRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -475,6 +477,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

28
lib/plex_ruby_sdk/plex.rb
View File

@@ -88,6 +88,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -130,6 +131,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -171,6 +173,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -212,27 +215,28 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
sig { params(include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), client_id: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) }
def get_server_resources(include_https = nil, include_relay = nil, include_i_pv6 = nil, client_id = nil, server_url = nil)
sig { params(client_id: ::String, include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) }
def get_server_resources(client_id, include_https = nil, include_relay = nil, include_i_pv6 = nil, server_url = nil)
# get_server_resources - Get Server Resources
# Get Plex server access tokens and server connections
request = ::PlexRubySDK::Operations::GetServerResourcesRequest.new(
client_id: client_id,
include_https: include_https,
include_relay: include_relay,
include_i_pv6: include_i_pv6,
client_id: client_id
include_i_pv6: include_i_pv6
)
base_url = Utils.template_url(GET_SERVER_RESOURCES_SERVERS[0], {
})
base_url = server_url if !server_url.nil?
url = "#{base_url}/resources"
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetServerResourcesRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetServerResourcesRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -263,6 +267,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -275,8 +280,8 @@ module PlexRubySDK
})
base_url = server_url if !server_url.nil?
url = "#{base_url}/pins"
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPinRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPinRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -301,6 +306,7 @@ module PlexRubySDK
res.bad_request = out
end
end
res
end
@@ -316,10 +322,9 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetTokenByPinIdRequest,
base_url,
'/pins/{pinID}',
request,
@sdk_configuration.globals
request
)
headers = Utils.get_headers(request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -348,6 +353,7 @@ module PlexRubySDK
res.object = out
end
end
res
end
end

33
lib/plex_ruby_sdk/plex_api.rb
View File

@@ -18,11 +18,6 @@ module PlexRubySDK
sig do
params(client: Faraday::Request,
security: T.nilable(Shared::Security),
client_id: ::String,
client_name: ::String,
client_version: ::String,
platform: ::String,
device_nickname: ::String,
protocol: T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol),
ip: T.nilable(::String),
port: T.nilable(::String),
@@ -32,11 +27,6 @@ module PlexRubySDK
end
def initialize(client: nil,
security: nil,
client_id: nil,
client_name: nil,
client_version: nil,
platform: nil,
device_nickname: nil,
protocol: nil,
ip: nil,
port: nil,
@@ -47,11 +37,6 @@ module PlexRubySDK
## Instantiates the SDK configuring it with the provided parameters.
# @param [Faraday::Request] client The faraday HTTP client to use for all operations
# @param [Shared::Security] security The security details required for authentication
# @param [::String] client_id: Configures the client_id parameter for all supported operations
# @param [::String] client_name: Configures the client_name parameter for all supported operations
# @param [::String] client_version: Configures the client_version parameter for all supported operations
# @param [::String] platform: Configures the platform parameter for all supported operations
# @param [::String] device_nickname: Configures the device_nickname parameter for all supported operations
# @param [T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol)] protocol: Allows setting the protocol variable for url substitution
# @param [T.nilable(::String)] ip: Allows setting the ip variable for url substitution
# @param [T.nilable(::String)] port: Allows setting the port variable for url substitution
@@ -83,23 +68,7 @@ module PlexRubySDK
},
]
globals = {
'parameters': {
'queryParam': {
},
'pathParam': {
},
'header': {
'client_id': client_id,
'client_name': client_name,
'client_version': client_version,
'platform': platform,
'device_nickname': device_nickname,
}
}
}
@sdk_configuration = SDKConfiguration.new(client, security, server_url, server_idx, server_params, globals)
@sdk_configuration = SDKConfiguration.new(client, security, server_url, server_idx, server_params)
init_sdks
end

12
lib/plex_ruby_sdk/sdkconfiguration.rb
View File

@@ -23,7 +23,6 @@ module PlexRubySDK
field :server_url, T.nilable(String)
field :server_idx, T.nilable(Integer)
field :server_params, Array[Hash[Symbol, String]], { 'default_factory': Array}
field :globals, Hash[Symbol, Hash[Symbol, Hash[Symbol, Object]]]
field :language, String
field :openapi_doc_version, String
field :sdk_version, String
@@ -31,20 +30,19 @@ module PlexRubySDK
field :user_agent, String
sig { params(client: Faraday::Connection, security: T.nilable(::PlexRubySDK::Shared::Security), server_url: T.nilable(String), server_idx: T.nilable(Integer), server_params: T::Array[String], globals: T::Hash[Symbol, T::Hash[Symbol, T::Hash[Symbol, Object]]]).void }
def initialize(client, security, server_url, server_idx, server_params, globals)
sig { params(client: Faraday::Connection, security: T.nilable(::PlexRubySDK::Shared::Security), server_url: T.nilable(String), server_idx: T.nilable(Integer), server_params: T::Array[String]).void }
def initialize(client, security, server_url, server_idx, server_params)
@client = client
@server_url = server_url
@server_idx = server_idx.nil? ? 0 : server_idx
raise StandardError, "Invalid server index #{server_idx}" if @server_idx.negative? || @server_idx >= SERVERS.length
@server_params = server_params
@security = security
@globals = globals.nil? ? {} : globals
@language = 'ruby'
@openapi_doc_version = '0.0.3'
@sdk_version = '0.5.1'
@gen_version = '2.457.9'
@user_agent = 'speakeasy-sdk/ruby 0.5.1 2.457.9 0.0.3 plex_ruby_sdk'
@sdk_version = '0.6.0'
@gen_version = '2.483.1'
@user_agent = 'speakeasy-sdk/ruby 0.6.0 2.483.1 0.0.3 plex_ruby_sdk'
end
sig { returns([String, T::Hash[Symbol, String]]) }

9
lib/plex_ruby_sdk/search.rb
View File

@@ -46,7 +46,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/hubs/search"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::PerformSearchRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::PerformSearchRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -73,6 +73,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -95,7 +96,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/hubs/search/voice"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::PerformVoiceSearchRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::PerformVoiceSearchRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -122,6 +123,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -138,7 +140,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/search"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchResultsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSearchResultsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -169,6 +171,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

13
lib/plex_ruby_sdk/server.rb
View File

@@ -57,6 +57,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -98,6 +99,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -139,6 +141,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -180,6 +183,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -215,6 +219,7 @@ module PlexRubySDK
res.request_timeout = out
end
end
res
end
@@ -256,6 +261,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -269,7 +275,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/photo/:/transcode"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetResizedPhotoRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetResizedPhotoRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -296,6 +302,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -311,7 +318,7 @@ module PlexRubySDK
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = "#{base_url}/media/providers"
headers = Utils.get_headers(request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -341,6 +348,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -382,6 +390,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

9
lib/plex_ruby_sdk/sessions.rb
View File

@@ -57,6 +57,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -76,7 +77,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/status/sessions/history/all"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSessionHistoryRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetSessionHistoryRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -107,6 +108,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -148,6 +150,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -166,8 +169,7 @@ module PlexRubySDK
::PlexRubySDK::Operations::StopTranscodeSessionRequest,
base_url,
'/transcode/sessions/{sessionKey}',
request,
@sdk_configuration.globals
request
)
headers = {}
headers['Accept'] = 'application/json'
@@ -195,6 +197,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

9
lib/plex_ruby_sdk/statistics.rb
View File

@@ -32,7 +32,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/statistics/media"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetStatisticsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetStatisticsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -63,6 +63,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -79,7 +80,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/statistics/resources"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetResourcesStatisticsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetResourcesStatisticsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -110,6 +111,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -126,7 +128,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/statistics/bandwidth"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetBandwidthStatisticsRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetBandwidthStatisticsRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -157,6 +159,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

7
lib/plex_ruby_sdk/updater.rb
View File

@@ -58,6 +58,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -74,7 +75,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/updater/check"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::CheckForUpdatesRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::CheckForUpdatesRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -101,6 +102,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -119,7 +121,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/updater/apply"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::ApplyUpdatesRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::ApplyUpdatesRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -146,6 +148,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

7
lib/plex_ruby_sdk/utils/utils.rb
View File

@@ -358,7 +358,7 @@ module PlexRubySDK
sig { params(content_type: String, pattern: String).returns(T::Boolean) }
def self.match_content_type(content_type, pattern)
return true if content_type == pattern || pattern == '*' || pattern == '*/*'
return true if content_type == pattern || ['*', '*/*'].include?(pattern)
pieces = content_type.split(';')
pieces.each do |piece|
@@ -593,7 +593,7 @@ module PlexRubySDK
file_fields = val.fields
file_name = ''
field_name = ''
field_name = field_metadata[:field_name]
content = nil
file_fields.each do |file_field|
@@ -603,11 +603,10 @@ module PlexRubySDK
if file_metadata[:content] == true
content = val.send(file_field.name)
else
field_name = file_metadata.fetch(:field_name, file_field.name)
file_name = val.send(file_field.name)
end
end
raise StandardError, 'invalid multipart/form-data file' if field_name == '' || file_name == '' || content == nil?
raise StandardError, 'invalid multipart/form-data file' if file_name == '' || content == nil?
form.append([field_name, [file_name, content]])
elsif field_metadata[:json] == true

6
lib/plex_ruby_sdk/video.rb
View File

@@ -28,7 +28,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/timeline"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTimelineRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTimelineRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -55,6 +55,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
@@ -67,7 +68,7 @@ module PlexRubySDK
base_url = Utils.template_url(url, params)
url = "#{base_url}/video/:/transcode/universal/start.mpd"
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::StartUniversalTranscodeRequest, request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::StartUniversalTranscodeRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -94,6 +95,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

8
lib/plex_ruby_sdk/watchlist.rb
View File

@@ -36,11 +36,10 @@ module PlexRubySDK
::PlexRubySDK::Operations::GetWatchListRequest,
base_url,
'/library/sections/watchlist/{filter}',
request,
@sdk_configuration.globals
request
)
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetWatchListRequest, request, @sdk_configuration.globals)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetWatchListRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -71,6 +70,7 @@ module PlexRubySDK
res.unauthorized = out
end
end
res
end
end

6
plex_ruby_sdk.gemspec
View File

@@ -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.5.1'
s.version = '0.6.0'
s.platform = Gem::Platform::RUBY
s.licenses = ['Apache-2.0']
s.summary = ''
@@ -25,11 +25,11 @@ Gem::Specification.new do |s|
s.add_dependency('faraday-multipart')
s.add_dependency('rack')
s.add_dependency('rake')
s.add_dependency('sorbet')
s.add_dependency('sorbet-runtime')
s.add_development_dependency('minitest')
s.add_development_dependency('rubocop', '~> 1.60.2')
s.add_development_dependency('sorbet-runtime')
s.add_development_dependency('sorbet')
s.add_development_dependency('tapioca')
end