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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0

Browse Source
This commit is contained in:
speakeasybot
2024-10-03 00:09:32 +00:00
parent d8100e0e9a
commit 0e73ee21f2
155 changed files with 2883 additions and 1722 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

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

12
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.405.6
speakeasyVersion: 1.406.0
sources:
my-source:
sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
tags:
- latest
- main
@@ -18,10 +18,10 @@ targets:
plexruby:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57
sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:9e29da1762cbdc612d7f42b05357b40f20cd9a8d7fa59da610f148b84219a34b
codeSamplesRevisionDigest: sha256:a72cb8eb9e33f7fad66102a4bb7b5bd468acf4718db491da2793aa177f8650e9
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

2
Gemfile.lock
View File

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

72
README.md
View File

@@ -44,7 +44,6 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Global Parameters](#global-parameters)
* [Server Selection](#server-selection)
<!-- End Table of Contents [toc] -->
@@ -68,11 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -132,6 +131,7 @@ end
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
* [get_search_all_libraries](docs/sdks/library/README.md#get_search_all_libraries) - Search All Libraries
* [get_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
@@ -258,11 +258,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -280,56 +280,6 @@ end
```
<!-- End Server Selection [server] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameters are available.
| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| client_id | ::String | | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) |
| client_name | ::String | | The client_name parameter. |
| client_version | ::String | | The client_version parameter. |
| client_platform | ::String | | The client_platform parameter. |
| device_name | ::String | | The device_name parameter. |
### Example
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
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="gcgzw5rz2xovp84b4vha3a40")
if ! res.plex_devices.nil?
# handle response
end
```
<!-- End Global Parameters [global-parameters] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development

12
RELEASES.md
View File

@@ -606,4 +606,14 @@ Based on:
### Generated
- [ruby v0.4.6] .
### Releases
- [Ruby Gems v0.4.6] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.6 - .
- [Ruby Gems v0.4.6] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.6 - .
## 2024-10-03 00:07:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.4.7] .
### Releases
- [Ruby Gems v0.4.7] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.7 - .

10
USAGE.md
View File

@@ -4,11 +4,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

156
codeSamples.yaml
View File

@@ -8,448 +8,454 @@ actions:
x-codeSamples:
- lang: ruby
label: getServerCapabilities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,\n type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType::TV_SHOW,\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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=\"gcgzw5rz2xovp84b4vha3a40\")\n\nif ! res.plex_devices.nil?\n # handle response\nend"
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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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 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"
- 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: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\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(\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"

102
docs/models/operations/features.md
View File

@@ -1,102 +0,0 @@
# Features
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

46
docs/models/operations/getalllibrariesdirectory.md
View File

@@ -3,26 +3,26 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *::String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *::String* | :heavy_check_mark: | N/A | 1 |
| `type` | *::String* | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Movies |
| `agent` | *::String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *::String* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *::String* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_check_mark: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *::String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *::String* | :heavy_check_mark: | N/A | 1 |
| `type` | *::String* | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Movies |
| `agent` | *::String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *::String* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *::String* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `location` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md)> | :heavy_check_mark: | N/A | |

9
docs/models/operations/getalllibrarieslocation.md Normal file
View File

@@ -0,0 +1,9 @@
# GetAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `path` | *::String* | :heavy_check_mark: | N/A | /movies |

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

@@ -10,4 +10,4 @@
| `height` | *::Integer* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

8
docs/models/operations/getlibraryitemslocation.md Normal file
View File

@@ -0,0 +1,8 @@
# GetLibraryItemsLocation
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

22
docs/models/operations/getlibraryitemsmedia.md
View File

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *::Integer* | :heavy_check_mark: | N/A | 25025 |
| `width` | *::Integer* | :heavy_check_mark: | N/A | 3840 |
| `height` | *::Integer* | :heavy_check_mark: | N/A | 2072 |
| `aspect_ratio` | *::Float* | :heavy_check_mark: | N/A | 1.85 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *::Integer* | :heavy_check_mark: | N/A | 6 |
| `audio_codec` | *::String* | :heavy_check_mark: | N/A | eac3 |
| `video_codec` | *::String* | :heavy_check_mark: | N/A | hevc |
| `video_resolution` | *::String* | :heavy_check_mark: | N/A | 4k |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k |
| `container` | *::String* | :heavy_check_mark: | N/A | mkv |
| `video_frame_rate` | *::String* | :heavy_check_mark: | N/A | 24p |
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming)](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |

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

@@ -52,6 +52,7 @@
| `writer` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMediaGuid](../../models/operations/getlibraryitemsmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors)](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)> | :heavy_minus_sign: | N/A | |

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

@@ -7,14 +7,14 @@
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail)](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)> | :heavy_minus_sign: | N/A | |

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

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `tag` | [::PlexRubySDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `include_guids` | [T.nilable(::PlexRubySDK::Operations::IncludeGuids)](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamType)](../../models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta)](../../models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

6
docs/models/operations/getmediaprovidersrequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

@@ -15,7 +15,7 @@
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Season 2 |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Reacher |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11 |

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

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

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

@@ -52,6 +52,7 @@
| `writer` | T::Array<[::PlexRubySDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::Collection](../../models/operations/collection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::UltraBlurColors)](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::MetaDataRating](../../models/operations/metadatarating.md)> | :heavy_minus_sign: | N/A | |

10
docs/models/operations/getsearchalllibrariesbadrequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `errors` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesErrors](../../models/operations/getsearchalllibrarieserrors.md)> | :heavy_minus_sign: | N/A |

8
docs/models/operations/getsearchalllibrariescollection.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesCollection
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Working NL Subs |

8
docs/models/operations/getsearchalllibrariescountry.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America |

8
docs/models/operations/getsearchalllibrariesdirector.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesDirector
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron |

10
docs/models/operations/getsearchalllibrarieserrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |

9
docs/models/operations/getsearchalllibrariesflattenseasons.md Normal file
View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesFlattenSeasons
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

8
docs/models/operations/getsearchalllibrariesgenre.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGenre
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Adventure |

9
docs/models/operations/getsearchalllibrarieshasthumbnail.md Normal file
View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesHasThumbnail
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

10
docs/models/operations/getsearchalllibrariesimage.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesImage
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `alt` | *::String* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [::PlexRubySDK::Operations::GetSearchAllLibrariesLibraryType](../../models/operations/getsearchalllibrarieslibrarytype.md) | :heavy_check_mark: | N/A | background |
| `url` | *::String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

10
docs/models/operations/getsearchalllibrarieslibraryerrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |

11
docs/models/operations/getsearchalllibrarieslibrarytype.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesLibraryType
## Values
| Name | Value |
| -------------- | -------------- |
| `COVER_POSTER` | coverPoster |
| `BACKGROUND` | background |
| `SNAPSHOT` | snapshot |
| `CLEAR_LOGO` | clearLogo |

8
docs/models/operations/getsearchalllibrarieslocation.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

25
docs/models/operations/getsearchalllibrariesmedia.md Normal file
View File

@@ -0,0 +1,25 @@
# GetSearchAllLibrariesMedia
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k |
| `container` | *::String* | :heavy_check_mark: | N/A | mkv |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesOptimizedForStreaming)](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)> | :heavy_check_mark: | N/A | |

9
docs/models/operations/getsearchalllibrariesmediacontainer.md Normal file
View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A |
| `search_result` | T::Array<[::PlexRubySDK::Operations::SearchResult](../../models/operations/searchresult.md)> | :heavy_check_mark: | N/A |

8
docs/models/operations/getsearchalllibrariesmediaguid.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesMediaGuid
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `id` | *::String* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

81
docs/models/operations/getsearchalllibrariesmetadata.md Normal file
View File

@@ -0,0 +1,81 @@
# GetSearchAllLibrariesMetadata
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [::PlexRubySDK::Operations::GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *::String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.6 |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `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 |
| `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 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `added_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMediaGuid](../../models/operations/getsearchalllibrariesmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesUltraBlurColors)](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)> | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)> | :heavy_minus_sign: | N/A | |
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

10
docs/models/operations/getsearchalllibrariesmetadatarating.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesMetaDataRating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *::String* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *::Float* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *::String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

9
docs/models/operations/getsearchalllibrariesoptimizedforstreaming.md Normal file
View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreaming
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

20
docs/models/operations/getsearchalllibrariespart.md Normal file
View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesPart
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesHasThumbnail)](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)> | :heavy_minus_sign: | N/A | |

13
docs/models/operations/getsearchalllibrariesrequest.md Normal file
View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRequest
## Fields
| 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 |
| `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 |
| `include_external_media` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia)](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

13
docs/models/operations/getsearchalllibrariesresponse.md Normal file
View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesResponseBody)](../../models/operations/getsearchalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesBadRequest)](../../models/operations/getsearchalllibrariesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesUnauthorized)](../../models/operations/getsearchalllibrariesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/models/operations/getsearchalllibrariesresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [::PlexRubySDK::Operations::GetSearchAllLibrariesMediaContainer](../../models/operations/getsearchalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |

13
docs/models/operations/getsearchalllibrariesrole.md Normal file
View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

20
docs/models/operations/getsearchalllibrariesshowordering.md Normal file
View File

@@ -0,0 +1,20 @@
# 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)).
## Values
| Name | Value |
| ------------- | ------------- |
| `NONE` | None |
| `TMDB_AIRING` | tmdbAiring |
| `AIRED` | aired |
| `DVD` | dvd |
| `ABSOLUTE` | absolute |

45
docs/models/operations/getsearchalllibrariesstream.md Normal file
View File

@@ -0,0 +1,45 @@
# GetSearchAllLibrariesStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 272796 |
| `stream_type` | *::Integer* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `codec` | *::String* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *::Integer* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `color_primaries` | *T.nilable(::String)* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `color_range` | *T.nilable(::String)* | :heavy_minus_sign: | The color range of the video stream | tv |
| `color_space` | *T.nilable(::String)* | :heavy_minus_sign: | The color space of the video stream | bt709 |
| `color_trc` | *T.nilable(::String)* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
| `bit_depth` | *T.nilable(::Integer)* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
| `chroma_location` | *T.nilable(::String)* | :heavy_minus_sign: | The chroma location of the video stream | left |
| `stream_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | The identifier of the video stream | 2 |
| `chroma_subsampling` | *T.nilable(::String)* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
| `coded_height` | *T.nilable(::Integer)* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
| `coded_width` | *T.nilable(::Integer)* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
| `frame_rate` | *T.nilable(::Float)* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
| `has_scaling_matrix` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
| `hearing_impaired` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `closed_captions` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `embedded_in_video` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | The height of the video stream | 1080 |
| `level` | *T.nilable(::Integer)* | :heavy_minus_sign: | The level of the video codec | 40 |
| `profile` | *T.nilable(::String)* | :heavy_minus_sign: | The profile of the video codec | main |
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of reference frames | 4 |
| `scan_type` | *T.nilable(::String)* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | The width of the video stream | 1920 |
| `display_title` | *T.nilable(::String)* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
| `extended_display_title` | *T.nilable(::String)* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
| `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
| `language` | *T.nilable(::String)* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
| `language_tag` | *T.nilable(::String)* | :heavy_minus_sign: | Language tag of the stream | en |
| `language_code` | *T.nilable(::String)* | :heavy_minus_sign: | Language code of the stream | eng |
| `audio_channel_layout` | *T.nilable(::String)* | :heavy_minus_sign: | The audio channel layout | stereo |
| `sampling_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
| `can_auto_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |

14
docs/models/operations/getsearchalllibrariestype.md Normal file
View File

@@ -0,0 +1,14 @@
# GetSearchAllLibrariesType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |

11
docs/models/operations/getsearchalllibrariesultrablurcolors.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUltraBlurColors
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `top_left` | *::String* | :heavy_check_mark: | N/A | 11333b |
| `top_right` | *::String* | :heavy_check_mark: | N/A | 0a232d |
| `bottom_right` | *::String* | :heavy_check_mark: | N/A | 73958 |
| `bottom_left` | *::String* | :heavy_check_mark: | N/A | 1f5066 |

10
docs/models/operations/getsearchalllibrariesunauthorized.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `errors` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesLibraryErrors](../../models/operations/getsearchalllibrarieslibraryerrors.md)> | :heavy_minus_sign: | N/A |

8
docs/models/operations/getsearchalllibrarieswriter.md Normal file
View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesWriter
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron |

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

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <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: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <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/getthumbimagerequest.md
View File

@@ -10,4 +10,4 @@
| `height` | *::Integer* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

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

102
docs/models/operations/gettokendetailsfeatures.md
View File

@@ -1,102 +0,0 @@
# GetTokenDetailsFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::GetTokenDetailsFeatures](../../models/operations/gettokendetailsfeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::GetTokenDetailsAuthenticationResponseStatus)](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

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

@@ -13,4 +13,4 @@
| `include_external_media` | [T.nilable(::PlexRubySDK::Operations::IncludeExternalMedia)](../../models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

7
docs/models/operations/location.md
View File

@@ -3,7 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `path` | *::String* | :heavy_check_mark: | N/A | /movies |
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

22
docs/models/operations/media.md
View File

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *::Integer* | :heavy_check_mark: | N/A | 25025 |
| `width` | *::Integer* | :heavy_check_mark: | N/A | 3840 |
| `height` | *::Integer* | :heavy_check_mark: | N/A | 2072 |
| `aspect_ratio` | *::Float* | :heavy_check_mark: | N/A | 1.85 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `audio_channels` | *::Integer* | :heavy_check_mark: | N/A | 6 |
| `audio_codec` | *::String* | :heavy_check_mark: | N/A | eac3 |
| `video_codec` | *::String* | :heavy_check_mark: | N/A | hevc |
| `video_resolution` | *::String* | :heavy_check_mark: | N/A | 4k |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k |
| `container` | *::String* | :heavy_check_mark: | N/A | mkv |
| `video_frame_rate` | *::String* | :heavy_check_mark: | N/A | 24p |
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::OptimizedForStreaming)](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |

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

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::HasThumbnail)](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::Stream](../../models/operations/stream.md)> | :heavy_minus_sign: | N/A | |

102
docs/models/operations/postuserssignindataauthenticationfeatures.md
View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataAuthenticationFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationFeatures](../../models/operations/postuserssignindataauthenticationfeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationResponseStatus)](../../models/operations/postuserssignindataauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

102
docs/models/operations/postuserssignindatafeatures.md
View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| 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_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 |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::PostUsersSignInDataFeatures](../../models/operations/postuserssignindatafeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationStatus)](../../models/operations/postuserssignindataauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

11
docs/models/operations/queryparamincludecollections.md Normal file
View File

@@ -0,0 +1,11 @@
# QueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/queryparamincludeexternalmedia.md Normal file
View File

@@ -0,0 +1,11 @@
# QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

9
docs/models/operations/searchresult.md Normal file
View File

@@ -0,0 +1,9 @@
# SearchResult
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `score` | *::Float* | :heavy_check_mark: | N/A |
| `metadata` | [::PlexRubySDK::Operations::GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A |

12
docs/models/operations/searchtypes.md Normal file
View File

@@ -0,0 +1,12 @@
# SearchTypes
## Values
| Name | Value |
| -------------- | -------------- |
| `MOVIES` | movies |
| `MUSIC` | music |
| `OTHER_VIDEOS` | otherVideos |
| `PEOPLE` | people |
| `TV` | tv |

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

@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::Features](../../models/operations/features.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::GetTokenDetailsAuthenticationStatus)](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

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

@@ -27,11 +27,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -65,11 +65,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -24,11 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -71,11 +71,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -115,11 +115,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -159,11 +159,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)

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

@@ -24,11 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -67,11 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -106,11 +106,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -149,11 +149,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -194,11 +194,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -22,11 +22,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -47,8 +47,8 @@ end
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `count` | *::Float* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [::PlexRubySDK::Operations::OnlyTransient](../../models/operations/onlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
| `count` | *T.nilable(::Float)* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [T.nilable(::PlexRubySDK::Operations::OnlyTransient)](../../models/operations/onlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
### Response
@@ -68,11 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -122,11 +122,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -148,8 +148,8 @@ end
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `section_id` | *::Float* | :heavy_check_mark: | the Id of the library to query |
| `count` | *::Float* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [::PlexRubySDK::Operations::QueryParamOnlyTransient](../../models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
| `count` | *T.nilable(::Float)* | :heavy_minus_sign: | The number of items to return with each hub. |
| `only_transient` | [T.nilable(::PlexRubySDK::Operations::QueryParamOnlyTransient)](../../models/operations/queryparamonlytransient.md) | :heavy_minus_sign: | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
### Response

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

@@ -15,6 +15,7 @@ API Calls interacting with Plex Media Server Libraries
* [get_library_items](#get_library_items) - Get Library Items
* [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](#get_search_library) - Search Library
* [get_search_all_libraries](#get_search_all_libraries) - Search All Libraries
* [get_meta_data_by_rating_key](#get_meta_data_by_rating_key) - Get Metadata by RatingKey
* [get_metadata_children](#get_metadata_children) - Get Items Children
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
@@ -31,11 +32,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -57,7 +58,7 @@ end
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `url` | *::String* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
| `type` | *::Float* | :heavy_minus_sign: | Item type | |
| `type` | *T.nilable(::Float)* | :heavy_minus_sign: | Item type | |
### Response
@@ -77,11 +78,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -150,11 +151,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -227,11 +228,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -253,7 +254,7 @@ end
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `include_details` | [::PlexRubySDK::Operations::IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `include_details` | [T.nilable(::PlexRubySDK::Operations::IncludeDetails)](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
### Response
@@ -272,11 +273,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -336,11 +337,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -350,10 +351,10 @@ s.config_security(
req = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(
section_key: 9518,
tag: ::PlexRubySDK::Operations::Tag::EDITION,
include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,
type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType::TV_SHOW,
section_key: 9518,
include_meta: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta::ENABLE,
x_plex_container_start: 0,
x_plex_container_size: 50,
@@ -391,11 +392,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -417,7 +418,7 @@ end
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `force` | [::PlexRubySDK::Operations::Force](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `force` | [T.nilable(::PlexRubySDK::Operations::Force)](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
### Response
@@ -454,11 +455,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -488,6 +489,60 @@ end
## get_search_all_libraries
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
### Example Usage
```ruby
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.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
req = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(
query: "<value>",
search_types: [
::PlexRubySDK::Operations::SearchTypes::PEOPLE,
],
include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,
include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,
)
res = s.library.get_search_all_libraries(req)
if ! res.object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `request` | [::PlexRubySDK::Operations::GetSearchAllLibrariesRequest](../../models/operations/getsearchalllibrariesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesResponse)](../../models/operations/getsearchalllibrariesresponse.md)**
## get_meta_data_by_rating_key
This endpoint will return the metadata of a library item specified with the ratingKey.
@@ -500,11 +555,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -545,11 +600,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -571,7 +626,7 @@ end
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
| `include_elements` | *::String* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
| `include_elements` | *T.nilable(::String)* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
### Response
@@ -591,11 +646,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -617,7 +672,7 @@ end
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_guids` | *::Integer* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
### Response
@@ -637,11 +692,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -23,11 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -90,11 +90,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -139,11 +139,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -24,11 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -68,11 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -113,11 +113,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -159,11 +159,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -212,11 +212,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -34,11 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -85,11 +85,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -108,10 +108,10 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `playlist_type` | [::PlexRubySDK::Operations::PlaylistType](../../models/operations/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
| `smart` | [::PlexRubySDK::Operations::QueryParamSmart](../../models/operations/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `playlist_type` | [T.nilable(::PlexRubySDK::Operations::PlaylistType)](../../models/operations/playlisttype.md) | :heavy_minus_sign: | limit to a type of playlist. |
| `smart` | [T.nilable(::PlexRubySDK::Operations::QueryParamSmart)](../../models/operations/queryparamsmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
### Response
@@ -132,11 +132,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -177,11 +177,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -222,11 +222,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -248,8 +248,8 @@ end
| Parameter | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist |
| `title` | *::String* | :heavy_minus_sign: | name of the playlist |
| `summary` | *::String* | :heavy_minus_sign: | summary description of the playlist |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | name of the playlist |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | summary description of the playlist |
### Response
@@ -272,11 +272,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -318,11 +318,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -364,11 +364,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -391,7 +391,7 @@ end
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
| `uri` | *::String* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `play_queue_id` | *::Float* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
| `play_queue_id` | *T.nilable(::Float)* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
### Response
@@ -411,11 +411,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -26,11 +26,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -70,11 +70,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -114,11 +114,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
@@ -153,11 +153,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -191,11 +191,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -204,7 +204,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="gcgzw5rz2xovp84b4vha3a40")
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")
if ! res.plex_devices.nil?
# handle response
@@ -214,13 +214,13 @@ end
### Parameters
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_https` | [::PlexRubySDK::Operations::IncludeHttps](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [::PlexRubySDK::Operations::IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [::PlexRubySDK::Operations::IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *::String* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `include_https` | [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,11 +239,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
@@ -281,11 +281,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)

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

@@ -25,4 +25,4 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| 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) | -
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -

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

@@ -34,11 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -60,8 +60,8 @@ end
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `query` | *::String* | :heavy_check_mark: | The query term | arnold |
| `section_id` | *::Float* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `limit` | *::Float* | :heavy_minus_sign: | The number of items to return per hub | 5 |
| `section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `limit` | *T.nilable(::Float)* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
@@ -84,11 +84,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -110,8 +110,8 @@ end
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `query` | *::String* | :heavy_check_mark: | The query term | dead+poop |
| `section_id` | *::Float* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `limit` | *::Float* | :heavy_minus_sign: | The number of items to return per hub | 5 |
| `section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `limit` | *T.nilable(::Float)* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
@@ -130,11 +130,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -28,11 +28,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -66,11 +66,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -104,11 +104,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -142,11 +142,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -180,11 +180,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
client_version: "2.4.1",
platform: "Roku",
device_nickname: "Roku 3",
)
@@ -213,11 +213,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -252,11 +252,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -306,11 +306,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -329,9 +329,9 @@ end
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
### Response
@@ -350,11 +350,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -23,11 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -61,11 +61,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -86,10 +86,10 @@ end
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort` | *::String* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `account_id` | *::Integer* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [::PlexRubySDK::Operations::QueryParamFilter](../../models/operations/queryparamfilter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `library_section_id` | *::Integer* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
| `sort` | *T.nilable(::String)* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `account_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `filter` | [T.nilable(::PlexRubySDK::Operations::QueryParamFilter)](../../models/operations/queryparamfilter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
### Response
@@ -108,11 +108,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -146,11 +146,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -22,11 +22,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -47,7 +47,7 @@ end
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
@@ -66,11 +66,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -91,7 +91,7 @@ end
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response
@@ -110,11 +110,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -135,7 +135,7 @@ end
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> | 4 |
### Response

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

@@ -23,11 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -61,11 +61,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -84,9 +84,9 @@ end
### Parameters
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `download` | [::PlexRubySDK::Operations::Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `download` | [T.nilable(::PlexRubySDK::Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
@@ -106,11 +106,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -131,8 +131,8 @@ end
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [::PlexRubySDK::Operations::Tonight](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [::PlexRubySDK::Operations::Skip](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |
| `tonight` | [T.nilable(::PlexRubySDK::Operations::Tonight)](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [T.nilable(::PlexRubySDK::Operations::Skip)](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |
### Response

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

@@ -21,11 +21,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(
@@ -78,11 +78,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

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

@@ -20,11 +20,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
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(

4
lib/plex_ruby_sdk/authentication.rb
View File

@@ -170,16 +170,14 @@ module PlexRubySDK
})
base_url = server_url if !server_url.nil?
url = "#{base_url}/users/signin"
headers = {}
headers = Utils.get_headers(request, @sdk_configuration.globals)
req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :form)
headers['content-type'] = req_content_type
query_params = Utils.get_query_params(::PlexRubySDK::Operations::PostUsersSignInDataRequest, request, @sdk_configuration.globals)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
r = @sdk_configuration.client.post(url) do |req|
req.headers = headers
req.params = query_params
if form
req.body = Utils.encode_form(form)
elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

44
lib/plex_ruby_sdk/library.rb
View File

@@ -487,6 +487,50 @@ module PlexRubySDK
end
sig { params(request: T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesRequest)).returns(::PlexRubySDK::Operations::GetSearchAllLibrariesResponse) }
def get_search_all_libraries(request)
# get_search_all_libraries - Search All Libraries
# Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
#
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['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
r = @sdk_configuration.client.get(url) do |req|
req.headers = headers
req.params = query_params
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
end
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
res = ::PlexRubySDK::Operations::GetSearchAllLibrariesResponse.new(
status_code: r.status, content_type: content_type, raw_response: r
)
if r.status == 200
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetSearchAllLibrariesResponseBody)
res.object = out
end
elsif r.status == 400
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetSearchAllLibrariesBadRequest)
res.bad_request = out
end
elsif r.status == 401
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetSearchAllLibrariesUnauthorized)
res.unauthorized = out
end
end
res
end
sig { params(rating_key: ::Integer).returns(::PlexRubySDK::Operations::GetMetaDataByRatingKeyResponse) }
def get_meta_data_by_rating_key(rating_key)
# get_meta_data_by_rating_key - Get Metadata by RatingKey

4
lib/plex_ruby_sdk/media.rb
View File

@@ -165,7 +165,7 @@ module PlexRubySDK
request,
@sdk_configuration.globals
)
headers = {}
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetBannerImageRequest, request, @sdk_configuration.globals)
headers['Accept'] = 'application/json;q=1, image/jpeg;q=0'
headers['user-agent'] = @sdk_configuration.user_agent
@@ -213,7 +213,7 @@ module PlexRubySDK
request,
@sdk_configuration.globals
)
headers = {}
headers = Utils.get_headers(request, @sdk_configuration.globals)
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetThumbImageRequest, request, @sdk_configuration.globals)
headers['Accept'] = 'application/json;q=1, image/jpeg;q=0'
headers['user-agent'] = @sdk_configuration.user_agent

41
lib/plex_ruby_sdk/models/operations.rb
View File

@@ -257,6 +257,7 @@ module PlexRubySDK
autoload :Writer, 'plex_ruby_sdk/models/operations/writer.rb'
autoload :Collection, 'plex_ruby_sdk/models/operations/collection.rb'
autoload :Role, 'plex_ruby_sdk/models/operations/role.rb'
autoload :Location, 'plex_ruby_sdk/models/operations/location.rb'
autoload :MediaGuid, 'plex_ruby_sdk/models/operations/mediaguid.rb'
autoload :UltraBlurColors, 'plex_ruby_sdk/models/operations/ultrablurcolors.rb'
autoload :MetaDataRating, 'plex_ruby_sdk/models/operations/metadatarating.rb'
@@ -349,7 +350,7 @@ module PlexRubySDK
autoload :GetAllLibrariesUnauthorized, 'plex_ruby_sdk/models/operations/get_all_libraries_unauthorized.rb'
autoload :GetAllLibrariesErrors, 'plex_ruby_sdk/models/operations/get_all_libraries_errors.rb'
autoload :GetAllLibrariesBadRequest, 'plex_ruby_sdk/models/operations/get_all_libraries_badrequest.rb'
autoload :Location, 'plex_ruby_sdk/models/operations/location.rb'
autoload :GetAllLibrariesLocation, 'plex_ruby_sdk/models/operations/get_all_libraries_location.rb'
autoload :GetAllLibrariesDirectory, 'plex_ruby_sdk/models/operations/get_all_libraries_directory.rb'
autoload :GetAllLibrariesMediaContainer, 'plex_ruby_sdk/models/operations/get_all_libraries_mediacontainer.rb'
autoload :GetAllLibrariesResponseBody, 'plex_ruby_sdk/models/operations/get_all_libraries_responsebody.rb'
@@ -407,6 +408,7 @@ module PlexRubySDK
autoload :GetLibraryItemsWriter, 'plex_ruby_sdk/models/operations/get_library_items_writer.rb'
autoload :GetLibraryItemsCollection, 'plex_ruby_sdk/models/operations/get_library_items_collection.rb'
autoload :GetLibraryItemsRole, 'plex_ruby_sdk/models/operations/get_library_items_role.rb'
autoload :GetLibraryItemsLocation, 'plex_ruby_sdk/models/operations/get_library_items_location.rb'
autoload :GetLibraryItemsMediaGuid, 'plex_ruby_sdk/models/operations/get_library_items_mediaguid.rb'
autoload :GetLibraryItemsUltraBlurColors, 'plex_ruby_sdk/models/operations/get_library_items_ultrablurcolors.rb'
autoload :GetLibraryItemsMetaDataRating, 'plex_ruby_sdk/models/operations/get_library_items_metadatarating.rb'
@@ -442,6 +444,39 @@ module PlexRubySDK
autoload :GetSearchLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_search_library_mediacontainer.rb'
autoload :GetSearchLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_search_library_responsebody.rb'
autoload :GetSearchLibraryResponse, 'plex_ruby_sdk/models/operations/get_search_library_response.rb'
autoload :SearchTypes, 'plex_ruby_sdk/models/operations/searchtypes.rb'
autoload :QueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/queryparam_includecollections.rb'
autoload :QueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/queryparam_includeexternalmedia.rb'
autoload :GetSearchAllLibrariesRequest, 'plex_ruby_sdk/models/operations/get_search_all_libraries_request.rb'
autoload :GetSearchAllLibrariesLibraryErrors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_errors.rb'
autoload :GetSearchAllLibrariesUnauthorized, 'plex_ruby_sdk/models/operations/get_search_all_libraries_unauthorized.rb'
autoload :GetSearchAllLibrariesErrors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_errors.rb'
autoload :GetSearchAllLibrariesBadRequest, 'plex_ruby_sdk/models/operations/get_search_all_libraries_badrequest.rb'
autoload :GetSearchAllLibrariesType, 'plex_ruby_sdk/models/operations/get_search_all_libraries_type.rb'
autoload :GetSearchAllLibrariesFlattenSeasons, 'plex_ruby_sdk/models/operations/get_search_all_libraries_flattenseasons.rb'
autoload :GetSearchAllLibrariesShowOrdering, 'plex_ruby_sdk/models/operations/get_search_all_libraries_showordering.rb'
autoload :GetSearchAllLibrariesOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_search_all_libraries_optimizedforstreaming.rb'
autoload :GetSearchAllLibrariesHasThumbnail, 'plex_ruby_sdk/models/operations/get_search_all_libraries_hasthumbnail.rb'
autoload :GetSearchAllLibrariesStream, 'plex_ruby_sdk/models/operations/get_search_all_libraries_stream.rb'
autoload :GetSearchAllLibrariesPart, 'plex_ruby_sdk/models/operations/get_search_all_libraries_part.rb'
autoload :GetSearchAllLibrariesMedia, 'plex_ruby_sdk/models/operations/get_search_all_libraries_media.rb'
autoload :GetSearchAllLibrariesGenre, 'plex_ruby_sdk/models/operations/get_search_all_libraries_genre.rb'
autoload :GetSearchAllLibrariesCountry, 'plex_ruby_sdk/models/operations/get_search_all_libraries_country.rb'
autoload :GetSearchAllLibrariesDirector, 'plex_ruby_sdk/models/operations/get_search_all_libraries_director.rb'
autoload :GetSearchAllLibrariesWriter, 'plex_ruby_sdk/models/operations/get_search_all_libraries_writer.rb'
autoload :GetSearchAllLibrariesCollection, 'plex_ruby_sdk/models/operations/get_search_all_libraries_collection.rb'
autoload :GetSearchAllLibrariesRole, 'plex_ruby_sdk/models/operations/get_search_all_libraries_role.rb'
autoload :GetSearchAllLibrariesLocation, 'plex_ruby_sdk/models/operations/get_search_all_libraries_location.rb'
autoload :GetSearchAllLibrariesMediaGuid, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediaguid.rb'
autoload :GetSearchAllLibrariesUltraBlurColors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_ultrablurcolors.rb'
autoload :GetSearchAllLibrariesMetaDataRating, 'plex_ruby_sdk/models/operations/get_search_all_libraries_metadatarating.rb'
autoload :GetSearchAllLibrariesLibraryType, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_type.rb'
autoload :GetSearchAllLibrariesImage, 'plex_ruby_sdk/models/operations/get_search_all_libraries_image.rb'
autoload :GetSearchAllLibrariesMetadata, 'plex_ruby_sdk/models/operations/get_search_all_libraries_metadata.rb'
autoload :SearchResult, 'plex_ruby_sdk/models/operations/searchresult.rb'
autoload :GetSearchAllLibrariesMediaContainer, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediacontainer.rb'
autoload :GetSearchAllLibrariesResponseBody, 'plex_ruby_sdk/models/operations/get_search_all_libraries_responsebody.rb'
autoload :GetSearchAllLibrariesResponse, 'plex_ruby_sdk/models/operations/get_search_all_libraries_response.rb'
autoload :GetMetaDataByRatingKeyRequest, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_request.rb'
autoload :GetMetaDataByRatingKeyLibraryErrors, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_library_errors.rb'
autoload :GetMetaDataByRatingKeyUnauthorized, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_unauthorized.rb'
@@ -638,10 +673,8 @@ module PlexRubySDK
autoload :UserProfile, 'plex_ruby_sdk/models/operations/userprofile.rb'
autoload :GetTokenDetailsStatus, 'plex_ruby_sdk/models/operations/gettokendetails_status.rb'
autoload :Services, 'plex_ruby_sdk/models/operations/services.rb'
autoload :Features, 'plex_ruby_sdk/models/operations/features.rb'
autoload :GetTokenDetailsAuthenticationStatus, 'plex_ruby_sdk/models/operations/gettokendetails_authentication_status.rb'
autoload :Subscription, 'plex_ruby_sdk/models/operations/subscription.rb'
autoload :GetTokenDetailsFeatures, 'plex_ruby_sdk/models/operations/gettokendetails_features.rb'
autoload :GetTokenDetailsAuthenticationResponseStatus, 'plex_ruby_sdk/models/operations/gettokendetails_authentication_response_status.rb'
autoload :GetTokenDetailsSubscription, 'plex_ruby_sdk/models/operations/gettokendetails_subscription.rb'
autoload :GetTokenDetailsUserPlexAccount, 'plex_ruby_sdk/models/operations/gettokendetails_userplexaccount.rb'
@@ -661,10 +694,8 @@ module PlexRubySDK
autoload :PostUsersSignInDataUserProfile, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_userprofile.rb'
autoload :PostUsersSignInDataStatus, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_status.rb'
autoload :PostUsersSignInDataServices, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_services.rb'
autoload :PostUsersSignInDataFeatures, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_features.rb'
autoload :PostUsersSignInDataAuthenticationStatus, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_authentication_status.rb'
autoload :PostUsersSignInDataSubscription, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_subscription.rb'
autoload :PostUsersSignInDataAuthenticationFeatures, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_authentication_features.rb'
autoload :PostUsersSignInDataAuthenticationResponseStatus, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_authentication_response_status.rb'
autoload :PostUsersSignInDataAuthenticationSubscription, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_authentication_subscription.rb'
autoload :PostUsersSignInDataState, 'plex_ruby_sdk/models/operations/post_users_sign_in_data_state.rb'

114
lib/plex_ruby_sdk/models/operations/features.rb
View File

@@ -1,114 +0,0 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
FEATURES_SERVERS = [
'https://plex.tv/api/v2'
].freeze
class Features < T::Enum
enums do
ANDROID_DOLBY_VISION = new('Android - Dolby Vision')
ANDROID_PI_P = new('Android - PiP')
CU_SUNSET = new('CU Sunset')
HRK_ENABLE_EUR = new('HRK_enable_EUR')
TREBLE_SHOW_FEATURES = new('TREBLE-show-features')
AD_COUNTDOWN_TIMER = new('ad-countdown-timer')
ADAPTIVE_BITRATE = new('adaptive_bitrate')
ALBUM_TYPES = new('album-types')
ALLOW_DVR = new('allow_dvr')
AMAZON_LOOP_DEBUG = new('amazon-loop-debug')
AVOD_AD_ANALYSIS = new('avod-ad-analysis')
AVOD_NEW_MEDIA = new('avod-new-media')
BLACKLIST_GET_SIGNIN = new('blacklist_get_signin')
BOOST_VOICES = new('boost-voices')
CAMERA_UPLOAD = new('camera_upload')
CLIENT_RADIO_STATIONS = new('client-radio-stations')
CLOUDFLARE_TURNSTILE_REQUIRED = new('cloudflare-turnstile-required')
CLOUDSYNC = new('cloudsync')
COLLECTIONS = new('collections')
COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS = new('comments_and_replies_push_notifications')
COMMUNITY_ACCESS_PLEX_TV = new('community_access_plex_tv')
COMPANIONS_SONOS = new('companions_sonos')
CONTENT_FILTER = new('content_filter')
CUSTOM_HOME_REMOVAL = new('custom-home-removal')
DISABLE_HOME_USER_FRIENDSHIPS = new('disable_home_user_friendships')
DISABLE_SHARING_FRIENDSHIPS = new('disable_sharing_friendships')
DOWNLOADS_GATING = new('downloads-gating')
DRM_SUPPORT = new('drm_support')
DVR = new('dvr')
DVR_BLOCK_UNSUPPORTED_COUNTRIES = new('dvr-block-unsupported-countries')
EPG_RECENT_CHANNELS = new('epg-recent-channels')
EXCLUDE_RESTRICTIONS = new('exclude restrictions')
FEDERATED_AUTH = new('federated-auth')
FRIEND_REQUEST_PUSH_NOTIFICATIONS = new('friend_request_push_notifications')
GRANDFATHER_SYNC = new('grandfather-sync')
GUIDED_UPGRADE = new('guided-upgrade')
HARDWARE_TRANSCODING = new('hardware_transcoding')
HOME = new('home')
HWTRANSCODE = new('hwtranscode')
IMAGGA_V2 = new('imagga-v2')
INCREASE_PASSWORD_COMPLEXITY = new('increase-password-complexity')
IOS14_PRIVACY_BANNER = new('ios14-privacy-banner')
ITERABLE_NOTIFICATION_TOKENS = new('iterable-notification-tokens')
ITEM_CLUSTERS = new('item_clusters')
KEEP_PAYMENT_METHOD = new('keep-payment-method')
KEVIN_BACON = new('kevin-bacon')
KOREA_CONSENT = new('korea-consent')
LE_ISRG_ROOT_X1 = new('le_isrg_root_x1')
LETS_ENCRYPT = new('lets_encrypt')
LIGHTNING_DVR_PIVOT = new('lightning-dvr-pivot')
LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS = new('live-tv-support-incomplete-segments')
LIVETV = new('livetv')
LYRICS = new('lyrics')
METADATA_SEARCH = new('metadata_search')
MUSIC_ANALYSIS = new('music-analysis')
MUSIC_VIDEOS = new('music_videos')
NEW_PLEX_PASS_PRICES = new('new_plex_pass_prices')
NEWS_PROVIDER_SUNSET_MODAL = new('news-provider-sunset-modal')
NOMINATIM = new('nominatim')
PASS = new('pass')
PHOTOS_FAVORITES = new('photos-favorites')
PHOTOS_METADATA_EDITION = new('photos-metadata-edition')
PHOTOS_V6_EDIT = new('photosV6-edit')
PHOTOS_V6_TV_ALBUMS = new('photosV6-tv-albums')
PMS_HEALTH = new('pms_health')
PREMIUM_DASHBOARD = new('premium-dashboard')
PREMIUM_MUSIC_METADATA = new('premium_music_metadata')
RADIO = new('radio')
RATE_LIMIT_CLIENT_TOKEN = new('rate-limit-client-token')
SCROBBLING_SERVICE_PLEX_TV = new('scrobbling-service-plex-tv')
SESSION_BANDWIDTH_RESTRICTIONS = new('session_bandwidth_restrictions')
SESSION_KICK = new('session_kick')
SHARED_SERVER_NOTIFICATION = new('shared_server_notification')
SHARED_SOURCE_NOTIFICATION = new('shared_source_notification')
SIGNIN_NOTIFICATION = new('signin_notification')
SIGNIN_WITH_APPLE = new('signin_with_apple')
SILENCE_REMOVAL = new('silence-removal')
SLEEP_TIMER = new('sleep-timer')
SPRING_SERVE_AD_PROVIDER = new('spring_serve_ad_provider')
SYNC = new('sync')
SWEET_FADES = new('sweet-fades')
TRANSCODER_CACHE = new('transcoder_cache')
TRAILERS = new('trailers')
TUNER_SHARING = new('tuner-sharing')
TWO_FACTOR_AUTHENTICATION = new('two-factor-authentication')
UNSUPPORTEDTUNERS = new('unsupportedtuners')
UPGRADE_3DS2 = new('upgrade-3ds2')
VISUALIZERS = new('visualizers')
VOD_SCHEMA = new('vod-schema')
VOD_CLOUDFLARE = new('vod_cloudflare')
VOLUME_LEVELING = new('volume-leveling')
WATCH_TOGETHER_INVITE = new('watch-together-invite')
WATCHLIST_RSS = new('watchlist-rss')
WEB_SERVER_DASHBOARD = new('web_server_dashboard')
WEBHOOKS = new('webhooks')
end
end
end
end

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

@@ -36,7 +36,7 @@ module PlexRubySDK
field :language, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('language') } }
field :location, T::Array[::PlexRubySDK::Operations::Location], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Location') } }
field :location, T::Array[::PlexRubySDK::Operations::GetAllLibrariesLocation], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Location') } }
field :refreshing, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('refreshing') } }
# Unix epoch datetime in seconds
@@ -55,7 +55,7 @@ module PlexRubySDK
field :uuid, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('uuid') } }
sig { params(agent: ::String, allow_sync: T::Boolean, art: ::String, composite: ::String, content: T::Boolean, content_changed_at: ::Integer, created_at: ::Integer, directory: T::Boolean, filters: T::Boolean, hidden: ::Integer, key: ::String, language: ::String, location: T::Array[::PlexRubySDK::Operations::Location], refreshing: T::Boolean, scanned_at: ::Integer, scanner: ::String, thumb: ::String, title: ::String, type: ::String, updated_at: ::Integer, uuid: ::String).void }
sig { params(agent: ::String, allow_sync: T::Boolean, art: ::String, composite: ::String, content: T::Boolean, content_changed_at: ::Integer, created_at: ::Integer, directory: T::Boolean, filters: T::Boolean, hidden: ::Integer, key: ::String, language: ::String, location: T::Array[::PlexRubySDK::Operations::GetAllLibrariesLocation], refreshing: T::Boolean, scanned_at: ::Integer, scanner: ::String, thumb: ::String, title: ::String, type: ::String, updated_at: ::Integer, uuid: ::String).void }
def initialize(agent: nil, allow_sync: nil, art: nil, composite: nil, content: nil, content_changed_at: nil, created_at: nil, directory: nil, filters: nil, hidden: nil, key: nil, language: nil, location: nil, refreshing: nil, scanned_at: nil, scanner: nil, thumb: nil, title: nil, type: nil, updated_at: nil, uuid: nil)
@agent = agent
@allow_sync = allow_sync

27
lib/plex_ruby_sdk/models/operations/get_all_libraries_location.rb Normal file
View File

@@ -0,0 +1,27 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllLibrariesLocation < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
field :path, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('path') } }
sig { params(id: ::Integer, path: ::String).void }
def initialize(id: nil, path: nil)
@id = id
@path = path
end
end
end
end

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

@@ -21,8 +21,8 @@ module PlexRubySDK
field :upscale, ::Integer, { 'query_param': { 'field_name': 'upscale', 'style': 'form', 'explode': true } }
field :width, ::Integer, { 'query_param': { 'field_name': 'width', 'style': 'form', 'explode': true } }
# Plex Authentication Token
field :x_plex_token, ::String, { 'query_param': { 'field_name': 'X-Plex-Token', 'style': 'form', 'explode': true } }
# An authentication token, obtained from plex.tv
field :x_plex_token, ::String, { 'header': { 'field_name': 'X-Plex-Token', 'style': 'simple', 'explode': false } }
sig { params(height: ::Integer, min_size: ::Integer, rating_key: ::Integer, upscale: ::Integer, width: ::Integer, x_plex_token: ::String).void }

24
lib/plex_ruby_sdk/models/operations/get_library_items_location.rb Normal file
View File

@@ -0,0 +1,24 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetLibraryItemsLocation < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :path, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('path') } }
sig { params(path: T.nilable(::String)).void }
def initialize(path: nil)
@path = path
end
end
end
end

56
lib/plex_ruby_sdk/models/operations/get_library_items_media.rb
View File

@@ -12,63 +12,63 @@ module PlexRubySDK
extend T::Sig
field :aspect_ratio, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('aspectRatio') } }
field :audio_channels, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioChannels') } }
field :audio_codec, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioCodec') } }
field :bitrate, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('bitrate') } }
field :container, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
field :duration, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :height, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('height') } }
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
field :part, T::Array[::PlexRubySDK::Operations::GetLibraryItemsPart], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Part') } }
field :video_codec, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoCodec') } }
field :aspect_ratio, T.nilable(::Float), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('aspectRatio') } }
field :video_frame_rate, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoFrameRate') } }
field :audio_channels, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioChannels') } }
field :video_profile, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
field :video_resolution, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoResolution') } }
field :width, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('width') } }
field :audio_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioCodec') } }
field :audio_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioProfile') } }
field :bitrate, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('bitrate') } }
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :has64bit_offsets, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('has64bitOffsets') } }
field :has_voice_activity, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasVoiceActivity') } }
field :height, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('height') } }
field :optimized_for_streaming, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('optimizedForStreaming'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming, true) } }
field :video_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoCodec') } }
sig { params(aspect_ratio: ::Float, audio_channels: ::Integer, audio_codec: ::String, bitrate: ::Integer, container: ::String, duration: ::Integer, height: ::Integer, id: ::Integer, part: T::Array[::PlexRubySDK::Operations::GetLibraryItemsPart], video_codec: ::String, video_frame_rate: ::String, video_profile: ::String, video_resolution: ::String, width: ::Integer, audio_profile: T.nilable(::String), has64bit_offsets: T.nilable(T::Boolean), has_voice_activity: T.nilable(T::Boolean), optimized_for_streaming: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming)).void }
def initialize(aspect_ratio: nil, audio_channels: nil, audio_codec: nil, bitrate: nil, container: nil, duration: nil, height: nil, id: nil, part: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil, audio_profile: nil, has64bit_offsets: nil, has_voice_activity: nil, optimized_for_streaming: nil)
field :video_frame_rate, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoFrameRate') } }
field :video_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
field :video_resolution, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoResolution') } }
field :width, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('width') } }
sig { params(container: ::String, id: ::Integer, part: T::Array[::PlexRubySDK::Operations::GetLibraryItemsPart], aspect_ratio: T.nilable(::Float), audio_channels: T.nilable(::Integer), audio_codec: T.nilable(::String), audio_profile: T.nilable(::String), bitrate: T.nilable(::Integer), duration: T.nilable(::Integer), has64bit_offsets: T.nilable(T::Boolean), has_voice_activity: T.nilable(T::Boolean), height: T.nilable(::Integer), optimized_for_streaming: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming), video_codec: T.nilable(::String), video_frame_rate: T.nilable(::String), video_profile: T.nilable(::String), video_resolution: T.nilable(::String), width: T.nilable(::Integer)).void }
def initialize(container: nil, id: nil, part: nil, aspect_ratio: nil, audio_channels: nil, audio_codec: nil, audio_profile: nil, bitrate: nil, duration: nil, has64bit_offsets: nil, has_voice_activity: nil, height: nil, optimized_for_streaming: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil)
@container = container
@id = id
@part = part
@aspect_ratio = aspect_ratio
@audio_channels = audio_channels
@audio_codec = audio_codec
@audio_profile = audio_profile
@bitrate = bitrate
@container = container
@duration = duration
@has64bit_offsets = has64bit_offsets
@has_voice_activity = has_voice_activity
@height = height
@id = id
@part = part
@optimized_for_streaming = optimized_for_streaming
@video_codec = video_codec
@video_frame_rate = video_frame_rate
@video_profile = video_profile
@video_resolution = video_resolution
@width = width
@audio_profile = audio_profile
@has64bit_offsets = has64bit_offsets
@has_voice_activity = has_voice_activity
@optimized_for_streaming = optimized_for_streaming
end
end
end

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

@@ -88,6 +88,8 @@ module PlexRubySDK
field :library_section_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionKey') } }
field :library_section_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionTitle') } }
field :location, T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsLocation]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Location') } }
# The Media object is only included when type query is `4` or higher.
#
field :media, T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMedia]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Media') } }
@@ -171,8 +173,8 @@ module PlexRubySDK
field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('year') } }
sig { params(added_at: ::Integer, guid: ::String, key: ::String, rating_key: ::String, summary: ::String, title: ::String, type: ::PlexRubySDK::Operations::GetLibraryItemsLibraryType, art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), banner: T.nilable(::String), chapter_source: T.nilable(::String), child_count: T.nilable(::Integer), collection: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsCollection]), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsCountry]), director: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsDirector]), duration: T.nilable(::Integer), flatten_seasons: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsFlattenSeasons), genre: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsGenre]), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_slug: T.nilable(::String), grandparent_theme: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), has_premium_extras: T.nilable(::String), has_premium_primary_extra: T.nilable(::String), image: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsImage]), index: T.nilable(::Integer), last_viewed_at: T.nilable(::Integer), leaf_count: T.nilable(::Integer), 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::GetLibraryItemsMedia]), media_guid: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMediaGuid]), meta_data_rating: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMetaDataRating]), originally_available_at: T.nilable(::Date), original_title: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_slug: T.nilable(::String), parent_studio: T.nilable(::String), parent_theme: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), primary_extra_key: T.nilable(::String), rating: T.nilable(::Float), rating_image: T.nilable(::String), role: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsRole]), season_count: T.nilable(::Integer), show_ordering: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering), skip_children: T.nilable(T::Boolean), skip_count: T.nilable(::Integer), slug: T.nilable(::String), studio: T.nilable(::String), tagline: T.nilable(::String), theme: T.nilable(::String), thumb: T.nilable(::String), title_sort: T.nilable(::String), ultra_blur_colors: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors), updated_at: T.nilable(::Integer), view_count: T.nilable(::Integer), viewed_leaf_count: T.nilable(::Integer), view_offset: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsWriter]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, guid: nil, key: nil, rating_key: nil, summary: nil, title: nil, type: nil, art: nil, audience_rating: nil, audience_rating_image: nil, banner: nil, chapter_source: nil, child_count: nil, collection: nil, content_rating: nil, country: nil, director: nil, duration: nil, flatten_seasons: nil, genre: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_slug: nil, grandparent_theme: nil, grandparent_thumb: nil, grandparent_title: nil, has_premium_extras: nil, has_premium_primary_extra: nil, image: nil, index: nil, last_viewed_at: nil, leaf_count: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, media: nil, media_guid: nil, meta_data_rating: nil, originally_available_at: nil, original_title: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_slug: nil, parent_studio: nil, parent_theme: nil, parent_thumb: nil, parent_title: nil, parent_year: nil, primary_extra_key: nil, rating: nil, rating_image: nil, role: nil, season_count: nil, show_ordering: nil, skip_children: nil, skip_count: nil, slug: nil, studio: nil, tagline: nil, theme: nil, thumb: nil, title_sort: nil, ultra_blur_colors: nil, updated_at: nil, view_count: nil, viewed_leaf_count: nil, view_offset: nil, writer: nil, year: nil)
sig { params(added_at: ::Integer, guid: ::String, key: ::String, rating_key: ::String, summary: ::String, title: ::String, type: ::PlexRubySDK::Operations::GetLibraryItemsLibraryType, art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), banner: T.nilable(::String), chapter_source: T.nilable(::String), child_count: T.nilable(::Integer), collection: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsCollection]), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsCountry]), director: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsDirector]), duration: T.nilable(::Integer), flatten_seasons: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsFlattenSeasons), genre: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsGenre]), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_slug: T.nilable(::String), grandparent_theme: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), has_premium_extras: T.nilable(::String), has_premium_primary_extra: T.nilable(::String), image: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsImage]), index: T.nilable(::Integer), last_viewed_at: T.nilable(::Integer), leaf_count: T.nilable(::Integer), library_section_id: T.nilable(::Integer), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), location: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsLocation]), media: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMedia]), media_guid: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMediaGuid]), meta_data_rating: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsMetaDataRating]), originally_available_at: T.nilable(::Date), original_title: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_slug: T.nilable(::String), parent_studio: T.nilable(::String), parent_theme: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), primary_extra_key: T.nilable(::String), rating: T.nilable(::Float), rating_image: T.nilable(::String), role: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsRole]), season_count: T.nilable(::Integer), show_ordering: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering), skip_children: T.nilable(T::Boolean), skip_count: T.nilable(::Integer), slug: T.nilable(::String), studio: T.nilable(::String), tagline: T.nilable(::String), theme: T.nilable(::String), thumb: T.nilable(::String), title_sort: T.nilable(::String), ultra_blur_colors: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors), updated_at: T.nilable(::Integer), view_count: T.nilable(::Integer), viewed_leaf_count: T.nilable(::Integer), view_offset: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsWriter]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, guid: nil, key: nil, rating_key: nil, summary: nil, title: nil, type: nil, art: nil, audience_rating: nil, audience_rating_image: nil, banner: nil, chapter_source: nil, child_count: nil, collection: nil, content_rating: nil, country: nil, director: nil, duration: nil, flatten_seasons: nil, genre: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_slug: nil, grandparent_theme: nil, grandparent_thumb: nil, grandparent_title: nil, has_premium_extras: nil, has_premium_primary_extra: nil, image: nil, index: nil, last_viewed_at: nil, leaf_count: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, location: nil, media: nil, media_guid: nil, meta_data_rating: nil, originally_available_at: nil, original_title: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_slug: nil, parent_studio: nil, parent_theme: nil, parent_thumb: nil, parent_title: nil, parent_year: nil, primary_extra_key: nil, rating: nil, rating_image: nil, role: nil, season_count: nil, show_ordering: nil, skip_children: nil, skip_count: nil, slug: nil, studio: nil, tagline: nil, theme: nil, thumb: nil, title_sort: nil, ultra_blur_colors: nil, updated_at: nil, view_count: nil, viewed_leaf_count: nil, view_offset: nil, writer: nil, year: nil)
@added_at = added_at
@guid = guid
@key = key
@@ -210,6 +212,7 @@ module PlexRubySDK
@library_section_id = library_section_id
@library_section_key = library_section_key
@library_section_title = library_section_title
@location = location
@media = media
@media_guid = media_guid
@meta_data_rating = meta_data_rating

16
lib/plex_ruby_sdk/models/operations/get_library_items_part.rb
View File

@@ -15,8 +15,6 @@ module PlexRubySDK
#
field :container, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
field :duration, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :file, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('file') } }
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
@@ -25,10 +23,10 @@ module PlexRubySDK
field :size, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
field :video_profile, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
field :audio_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioProfile') } }
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :has64bit_offsets, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('has64bitOffsets') } }
field :has_thumbnail, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasThumbnail'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail, true) } }
@@ -39,22 +37,24 @@ module PlexRubySDK
field :stream, T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsStream]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Stream') } }
field :video_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
sig { params(container: ::String, duration: ::Integer, file: ::String, id: ::Integer, key: ::String, size: ::Integer, video_profile: ::String, audio_profile: T.nilable(::String), has64bit_offsets: T.nilable(T::Boolean), has_thumbnail: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail), indexes: T.nilable(::String), optimized_for_streaming: T.nilable(T::Boolean), stream: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsStream])).void }
def initialize(container: nil, duration: nil, file: nil, id: nil, key: nil, size: nil, video_profile: nil, audio_profile: nil, has64bit_offsets: nil, has_thumbnail: nil, indexes: nil, optimized_for_streaming: nil, stream: nil)
sig { params(container: ::String, file: ::String, id: ::Integer, key: ::String, size: ::Integer, audio_profile: T.nilable(::String), duration: T.nilable(::Integer), has64bit_offsets: T.nilable(T::Boolean), has_thumbnail: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail), indexes: T.nilable(::String), optimized_for_streaming: T.nilable(T::Boolean), stream: T.nilable(T::Array[::PlexRubySDK::Operations::GetLibraryItemsStream]), video_profile: T.nilable(::String)).void }
def initialize(container: nil, file: nil, id: nil, key: nil, size: nil, audio_profile: nil, duration: nil, has64bit_offsets: nil, has_thumbnail: nil, indexes: nil, optimized_for_streaming: nil, stream: nil, video_profile: nil)
@container = container
@duration = duration
@file = file
@id = id
@key = key
@size = size
@video_profile = video_profile
@audio_profile = audio_profile
@duration = duration
@has64bit_offsets = has64bit_offsets
@has_thumbnail = has_thumbnail
@indexes = indexes
@optimized_for_streaming = optimized_for_streaming
@stream = stream
@video_profile = video_profile
end
end
end

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

@@ -11,8 +11,8 @@ module PlexRubySDK
class GetMediaProvidersRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# Plex Authentication Token
field :x_plex_token, ::String, { 'query_param': { 'field_name': 'X-Plex-Token', 'style': 'form', 'explode': true } }
# An authentication token, obtained from plex.tv
field :x_plex_token, ::String, { 'header': { 'field_name': 'X-Plex-Token', 'style': 'simple', 'explode': false } }
sig { params(x_plex_token: ::String).void }

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

@@ -88,6 +88,8 @@ module PlexRubySDK
field :library_section_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionKey') } }
field :library_section_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionTitle') } }
field :location, T.nilable(T::Array[::PlexRubySDK::Operations::Location]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Location') } }
# The Media object is only included when type query is `4` or higher.
#
field :media, T.nilable(T::Array[::PlexRubySDK::Operations::Media]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Media') } }
@@ -171,8 +173,8 @@ module PlexRubySDK
field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('year') } }
sig { params(added_at: ::Integer, guid: ::String, key: ::String, rating_key: ::String, summary: ::String, title: ::String, type: ::PlexRubySDK::Operations::GetRecentlyAddedHubsType, art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), banner: T.nilable(::String), chapter_source: T.nilable(::String), child_count: T.nilable(::Integer), collection: T.nilable(T::Array[::PlexRubySDK::Operations::Collection]), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::Country]), director: T.nilable(T::Array[::PlexRubySDK::Operations::Director]), duration: T.nilable(::Integer), flatten_seasons: T.nilable(::PlexRubySDK::Operations::FlattenSeasons), genre: T.nilable(T::Array[::PlexRubySDK::Operations::Genre]), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_slug: T.nilable(::String), grandparent_theme: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), has_premium_extras: T.nilable(::String), has_premium_primary_extra: T.nilable(::String), image: T.nilable(T::Array[::PlexRubySDK::Operations::GetRecentlyAddedImage]), index: T.nilable(::Integer), last_viewed_at: T.nilable(::Integer), leaf_count: T.nilable(::Integer), 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::Media]), media_guid: T.nilable(T::Array[::PlexRubySDK::Operations::MediaGuid]), meta_data_rating: T.nilable(T::Array[::PlexRubySDK::Operations::MetaDataRating]), originally_available_at: T.nilable(::Date), original_title: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_slug: T.nilable(::String), parent_studio: T.nilable(::String), parent_theme: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), primary_extra_key: T.nilable(::String), rating: T.nilable(::Float), rating_image: T.nilable(::String), role: T.nilable(T::Array[::PlexRubySDK::Operations::Role]), season_count: T.nilable(::Integer), show_ordering: T.nilable(::PlexRubySDK::Operations::ShowOrdering), skip_children: T.nilable(T::Boolean), skip_count: T.nilable(::Integer), slug: T.nilable(::String), studio: T.nilable(::String), tagline: T.nilable(::String), theme: T.nilable(::String), thumb: T.nilable(::String), title_sort: T.nilable(::String), ultra_blur_colors: T.nilable(::PlexRubySDK::Operations::UltraBlurColors), updated_at: T.nilable(::Integer), view_count: T.nilable(::Integer), viewed_leaf_count: T.nilable(::Integer), view_offset: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::Writer]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, guid: nil, key: nil, rating_key: nil, summary: nil, title: nil, type: nil, art: nil, audience_rating: nil, audience_rating_image: nil, banner: nil, chapter_source: nil, child_count: nil, collection: nil, content_rating: nil, country: nil, director: nil, duration: nil, flatten_seasons: nil, genre: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_slug: nil, grandparent_theme: nil, grandparent_thumb: nil, grandparent_title: nil, has_premium_extras: nil, has_premium_primary_extra: nil, image: nil, index: nil, last_viewed_at: nil, leaf_count: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, media: nil, media_guid: nil, meta_data_rating: nil, originally_available_at: nil, original_title: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_slug: nil, parent_studio: nil, parent_theme: nil, parent_thumb: nil, parent_title: nil, parent_year: nil, primary_extra_key: nil, rating: nil, rating_image: nil, role: nil, season_count: nil, show_ordering: nil, skip_children: nil, skip_count: nil, slug: nil, studio: nil, tagline: nil, theme: nil, thumb: nil, title_sort: nil, ultra_blur_colors: nil, updated_at: nil, view_count: nil, viewed_leaf_count: nil, view_offset: nil, writer: nil, year: nil)
sig { params(added_at: ::Integer, guid: ::String, key: ::String, rating_key: ::String, summary: ::String, title: ::String, type: ::PlexRubySDK::Operations::GetRecentlyAddedHubsType, art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), banner: T.nilable(::String), chapter_source: T.nilable(::String), child_count: T.nilable(::Integer), collection: T.nilable(T::Array[::PlexRubySDK::Operations::Collection]), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::Country]), director: T.nilable(T::Array[::PlexRubySDK::Operations::Director]), duration: T.nilable(::Integer), flatten_seasons: T.nilable(::PlexRubySDK::Operations::FlattenSeasons), genre: T.nilable(T::Array[::PlexRubySDK::Operations::Genre]), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_slug: T.nilable(::String), grandparent_theme: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), has_premium_extras: T.nilable(::String), has_premium_primary_extra: T.nilable(::String), image: T.nilable(T::Array[::PlexRubySDK::Operations::GetRecentlyAddedImage]), index: T.nilable(::Integer), last_viewed_at: T.nilable(::Integer), leaf_count: T.nilable(::Integer), library_section_id: T.nilable(::Integer), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), location: T.nilable(T::Array[::PlexRubySDK::Operations::Location]), media: T.nilable(T::Array[::PlexRubySDK::Operations::Media]), media_guid: T.nilable(T::Array[::PlexRubySDK::Operations::MediaGuid]), meta_data_rating: T.nilable(T::Array[::PlexRubySDK::Operations::MetaDataRating]), originally_available_at: T.nilable(::Date), original_title: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_slug: T.nilable(::String), parent_studio: T.nilable(::String), parent_theme: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), primary_extra_key: T.nilable(::String), rating: T.nilable(::Float), rating_image: T.nilable(::String), role: T.nilable(T::Array[::PlexRubySDK::Operations::Role]), season_count: T.nilable(::Integer), show_ordering: T.nilable(::PlexRubySDK::Operations::ShowOrdering), skip_children: T.nilable(T::Boolean), skip_count: T.nilable(::Integer), slug: T.nilable(::String), studio: T.nilable(::String), tagline: T.nilable(::String), theme: T.nilable(::String), thumb: T.nilable(::String), title_sort: T.nilable(::String), ultra_blur_colors: T.nilable(::PlexRubySDK::Operations::UltraBlurColors), updated_at: T.nilable(::Integer), view_count: T.nilable(::Integer), viewed_leaf_count: T.nilable(::Integer), view_offset: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::Writer]), year: T.nilable(::Integer)).void }
def initialize(added_at: nil, guid: nil, key: nil, rating_key: nil, summary: nil, title: nil, type: nil, art: nil, audience_rating: nil, audience_rating_image: nil, banner: nil, chapter_source: nil, child_count: nil, collection: nil, content_rating: nil, country: nil, director: nil, duration: nil, flatten_seasons: nil, genre: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_slug: nil, grandparent_theme: nil, grandparent_thumb: nil, grandparent_title: nil, has_premium_extras: nil, has_premium_primary_extra: nil, image: nil, index: nil, last_viewed_at: nil, leaf_count: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, location: nil, media: nil, media_guid: nil, meta_data_rating: nil, originally_available_at: nil, original_title: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_slug: nil, parent_studio: nil, parent_theme: nil, parent_thumb: nil, parent_title: nil, parent_year: nil, primary_extra_key: nil, rating: nil, rating_image: nil, role: nil, season_count: nil, show_ordering: nil, skip_children: nil, skip_count: nil, slug: nil, studio: nil, tagline: nil, theme: nil, thumb: nil, title_sort: nil, ultra_blur_colors: nil, updated_at: nil, view_count: nil, viewed_leaf_count: nil, view_offset: nil, writer: nil, year: nil)
@added_at = added_at
@guid = guid
@key = key
@@ -210,6 +212,7 @@ module PlexRubySDK
@library_section_id = library_section_id
@library_section_key = library_section_key
@library_section_title = library_section_title
@location = location
@media = media
@media_guid = media_guid
@meta_data_rating = meta_data_rating

Some files were not shown because too many files have changed in this diff Show More