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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4

Browse Source
This commit is contained in:
speakeasybot
2025-03-08 00:07:55 +00:00
parent 70e432702d
commit bec460dcc6
828 changed files with 3174 additions and 2001 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -26,15 +26,12 @@ Get Server Activities
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.activities.get_server_activities()
if ! res.object.nil?
@@ -58,15 +55,12 @@ Cancel Server Activities
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e")
if res.status_code == 200

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

@@ -23,15 +23,12 @@ This endpoint provides the caller with a temporary token with the same access le
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)
if res.status_code == 200
@@ -64,15 +61,12 @@ Note: requires Plex Media Server >= 1.15.4.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.authentication.get_source_connection_information(source="server://client-identifier")
if res.status_code == 200
@@ -102,15 +96,12 @@ Get the User data from the provided X-Plex-Token
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.authentication.get_token_details()
if ! res.user_plex_account.nil?
@@ -140,10 +131,8 @@ Sign in user with username and password and return user data with Plex authentic
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
@@ -156,7 +145,7 @@ req = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(
verification_code: "123456",
),
)
res = s.authentication.post_users_sign_in_data(req)
if ! res.user_plex_account.nil?

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

@@ -23,15 +23,12 @@ Returns a list of butler tasks
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.butler.get_butler_tasks()
if ! res.object.nil?
@@ -60,15 +57,12 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.butler.start_all_tasks()
if res.status_code == 200
@@ -93,15 +87,12 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.butler.stop_all_tasks()
if res.status_code == 200
@@ -130,15 +121,12 @@ This endpoint will attempt to start a single Butler task that is enabled in the
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)
if res.status_code == 200
@@ -169,15 +157,12 @@ This endpoint will stop a currently running task by name, or remove it from the
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)
if res.status_code == 200

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

@@ -21,15 +21,12 @@ Get Global Hubs filtered by the parameters provided.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)
if ! res.object.nil?
@@ -61,14 +58,11 @@ This endpoint will return the recently added content.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetRecentlyAddedRequest.new(
content_directory_id: 470161,
@@ -78,7 +72,7 @@ req = ::PlexRubySDK::Operations::GetRecentlyAddedRequest.new(
x_plex_container_start: 0,
x_plex_container_size: 50,
)
res = s.hubs.get_recently_added(req)
if ! res.object.nil?
@@ -109,15 +103,12 @@ This endpoint will return a list of library specific hubs
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.hubs.get_library_hubs(section_id=6728.76, count=639.24, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ONE)
if ! res.object.nil?

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

@@ -35,15 +35,12 @@ This resource returns hash values for local files
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_file_hash(url="file://C:\Image.png&type=13", type=4462.17)
if res.status_code == 200
@@ -75,14 +72,11 @@ This endpoint will return the recently added content.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest.new(
content_directory_id: 2,
@@ -106,7 +100,7 @@ req = ::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest.new(
x_plex_container_start: 0,
x_plex_container_size: 50,
)
res = s.library.get_recently_added_library(req)
if ! res.object.nil?
@@ -142,15 +136,12 @@ This allows a client to provide a rich interface around the media (e.g. allow so
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_all_libraries()
if ! res.object.nil?
@@ -213,15 +204,12 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)
if ! res.object.nil?
@@ -252,15 +240,12 @@ Delete a library using a specific section id
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.delete_library(section_key=9518)
if res.status_code == 200
@@ -311,14 +296,11 @@ Fetches details from a specific section of the library identified by a section k
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(
tag: ::PlexRubySDK::Operations::Tag::EDITION,
@@ -329,7 +311,7 @@ req = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(
x_plex_container_start: 0,
x_plex_container_size: 50,
)
res = s.library.get_library_items(req)
if ! res.object.nil?
@@ -360,14 +342,11 @@ Retrieves a list of all general media data for this library.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetAllMediaLibraryRequest.new(
section_key: 9518,
@@ -380,7 +359,7 @@ req = ::PlexRubySDK::Operations::GetAllMediaLibraryRequest.new(
x_plex_container_start: 0,
x_plex_container_size: 50,
)
res = s.library.get_all_media_library(req)
if ! res.object.nil?
@@ -411,15 +390,12 @@ This endpoint Refreshes all the Metadata of the library.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)
if res.status_code == 200
@@ -468,15 +444,12 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::GetSearchLibraryQueryParamType::TV_SHOW)
if ! res.object.nil?
@@ -508,15 +481,12 @@ Retrieves a list of all the genres that are found for the media in this library.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_genres_library(section_key=9518, type=::PlexRubySDK::Operations::GetGenresLibraryQueryParamType::TV_SHOW)
if ! res.object.nil?
@@ -548,15 +518,12 @@ Retrieves a list of all the countries that are found for the media in this libra
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_countries_library(section_key=9518, type=::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType::TV_SHOW)
if ! res.object.nil?
@@ -588,15 +555,12 @@ Retrieves a list of all the actors that are found for the media in this library.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_actors_library(section_key=9518, type=::PlexRubySDK::Operations::GetActorsLibraryQueryParamType::TV_SHOW)
if ! res.object.nil?
@@ -628,14 +592,11 @@ Search the provided query across all library sections, or a single section, and
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(
query: "<value>",
@@ -646,7 +607,7 @@ req = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(
include_collections: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeCollections::ENABLE,
include_external_media: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeExternalMedia::ENABLE,
)
res = s.library.get_search_all_libraries(req)
if ! res.object.nil?
@@ -677,14 +638,11 @@ This endpoint will return all the (meta)data of a library item specified with by
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetMediaMetaDataRequest.new(
rating_key: 9518,
@@ -702,7 +660,7 @@ req = ::PlexRubySDK::Operations::GetMediaMetaDataRequest.new(
async_refresh_analysis: true,
async_refresh_local_media_agent: true,
)
res = s.library.get_media_meta_data(req)
if ! res.object.nil?
@@ -733,15 +691,12 @@ This endpoint will return the children of of a library item specified with the r
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="<value>")
if ! res.object.nil?
@@ -773,15 +728,12 @@ This endpoint will return the top watched content from libraries of a certain ty
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TV_SHOW, include_guids=1)
if ! res.object.nil?
@@ -813,15 +765,12 @@ This endpoint will return the on deck content.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.library.get_on_deck()
if ! res.object.nil?

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

@@ -22,15 +22,12 @@ This endpoint will write a single-line log message, including a level and source
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message="Test log message", source="Postman")
if res.status_code == 200
@@ -83,19 +80,16 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = "level=4&message=Test%20message%201&source=postman\n" +
"level=3&message=Test%20message%202&source=postman\n" +
"level=1&message=Test%20message%203&source=postman"
res = s.log.log_multi_line(req)
if res.status_code == 200
@@ -126,15 +120,12 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.log.enable_paper_trail()
if res.status_code == 200

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

@@ -23,15 +23,12 @@ This will mark the provided media key as Played.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.media.mark_played(key=59398.0)
if res.status_code == 200
@@ -61,15 +58,12 @@ This will mark the provided media key as Unplayed.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.media.mark_unplayed(key=59398.0)
if res.status_code == 200
@@ -100,15 +94,12 @@ This API command can be used to update the play progress of a media item.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.media.update_play_progress(key="<key>", time=90000.0, state="played")
if res.status_code == 200
@@ -140,14 +131,11 @@ Gets the banner image of the media item
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetBannerImageRequest.new(
rating_key: 9518,
@@ -157,7 +145,7 @@ req = ::PlexRubySDK::Operations::GetBannerImageRequest.new(
upscale: 1,
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.media.get_banner_image(req)
if ! res.bytes.nil?
@@ -187,14 +175,11 @@ Gets the thumbnail image of the media item
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetThumbImageRequest.new(
rating_key: 9518,
@@ -204,7 +189,7 @@ req = ::PlexRubySDK::Operations::GetThumbImageRequest.new(
upscale: 1,
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.media.get_thumb_image(req)
if ! res.bytes.nil?

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

@@ -33,14 +33,11 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(
title: "<value>",
@@ -48,7 +45,7 @@ req = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(
smart: ::PlexRubySDK::Operations::Smart::ONE,
uri: "https://hoarse-testing.info/",
)
res = s.playlists.create_playlist(req)
if ! res.object.nil?
@@ -78,15 +75,12 @@ Get All Playlists given the specified filters.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)
if ! res.object.nil?
@@ -119,15 +113,12 @@ Smart playlist details contain the `content` attribute. This is the content URI
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.get_playlist(playlist_id=4109.48)
if ! res.object.nil?
@@ -158,15 +149,12 @@ This endpoint will delete a playlist
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.delete_playlist(playlist_id=216.22)
if res.status_code == 200
@@ -197,15 +185,12 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.update_playlist(playlist_id=3915.0, title="<value>", summary="<value>")
if res.status_code == 200
@@ -241,15 +226,12 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TV_SHOW)
if ! res.object.nil?
@@ -281,15 +263,12 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.clear_playlist_contents(playlist_id=1893.18)
if res.status_code == 200
@@ -321,15 +300,12 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123.0)
if ! res.object.nil?
@@ -362,15 +338,12 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=::PlexRubySDK::Operations::QueryParamForce::ZERO, section_id=1)
if res.status_code == 200

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

@@ -25,15 +25,12 @@ Get Companions Data
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.plex.get_companions_data()
if ! res.response_bodies.nil?
@@ -63,15 +60,12 @@ Get friends of provided auth token.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.plex.get_user_friends()
if ! res.friends.nil?
@@ -101,10 +95,8 @@ Returns the geolocation and locale data of the caller
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
res = s.plex.get_geo_data()
if ! res.geo_data.nil?
@@ -134,15 +126,12 @@ Retrieves the home data for the authenticated user, including details like home
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.plex.get_home_data()
if ! res.object.nil?
@@ -166,15 +155,12 @@ Get Plex server access tokens and server connections
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.plex.get_server_resources(client_id="3381b62b-9ab7-4e37-827b-203e9809eb58", include_https=::PlexRubySDK::Operations::IncludeHttps::ENABLE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ENABLE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ENABLE)
if ! res.plex_devices.nil?
@@ -208,10 +194,8 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetPinRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
@@ -219,7 +203,7 @@ req = ::PlexRubySDK::Operations::GetPinRequest.new(
client_version: "2.4.1",
platform: "Roku",
)
res = s.plex.get_pin(req)
if ! res.auth_pin_container.nil?
@@ -250,10 +234,8 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(
pin_id: 408895,
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
@@ -262,7 +244,7 @@ req = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(
client_version: "2.4.1",
platform: "Roku",
)
res = s.plex.get_token_by_pin_id(req)
if ! res.auth_pin_container.nil?

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

@@ -33,15 +33,12 @@ This request is intended to be very fast, and called as the user types.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.search.perform_search(query="dylan", section_id=9372.7, limit=5.0)
if res.status_code == 200
@@ -77,15 +74,12 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.search.perform_voice_search(query="dead+poop", section_id=4094.8, limit=5.0)
if res.status_code == 200
@@ -117,15 +111,12 @@ This will search the database for the string provided.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.search.get_search_results(query="110")
if ! res.object.nil?

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

@@ -27,15 +27,12 @@ Get Server Capabilities
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_server_capabilities()
if ! res.object.nil?
@@ -59,15 +56,12 @@ Get Server Preferences
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_server_preferences()
if ! res.object.nil?
@@ -91,15 +85,12 @@ Get Available Clients
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_available_clients()
if ! res.object.nil?
@@ -123,15 +114,12 @@ Get Devices
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_devices()
if ! res.object.nil?
@@ -155,10 +143,8 @@ This request is useful to determine if the server is online or offline
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
res = s.server.get_server_identity()
if ! res.object.nil?
@@ -182,15 +168,12 @@ Returns MyPlex Account Information
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_my_plex_account()
if ! res.object.nil?
@@ -215,14 +198,11 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(
width: 110.0,
@@ -233,7 +213,7 @@ req = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(
upscale: ::PlexRubySDK::Operations::Upscale::ONE,
url: "/library/metadata/49564/thumb/1654258204",
)
res = s.server.get_resized_photo(req)
if res.status_code == 200
@@ -263,15 +243,12 @@ Retrieves media providers and their features from the Plex server.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf")
if ! res.object.nil?
@@ -301,15 +278,12 @@ Get Server List
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.server.get_server_list()
if ! res.object.nil?

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

@@ -22,15 +22,12 @@ This will retrieve the "Now Playing" Information of the PMS.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.sessions.get_sessions()
if ! res.object.nil?
@@ -54,15 +51,12 @@ This will Retrieve a listing of all history views.
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.sessions.get_session_history(sort="<value>", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)
if ! res.object.nil?
@@ -95,15 +89,12 @@ Get Transcode Sessions
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.sessions.get_transcode_sessions()
if ! res.object.nil?
@@ -127,15 +118,12 @@ Stop a Transcode Session
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep")
if res.status_code == 200

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

@@ -21,15 +21,12 @@ This will return the media statistics for the server
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.statistics.get_statistics(timespan=4)
if ! res.object.nil?
@@ -59,15 +56,12 @@ This will return the resources for the server
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.statistics.get_resources_statistics(timespan=4)
if ! res.object.nil?
@@ -97,15 +91,12 @@ This will return the bandwidth statistics for the server
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.statistics.get_bandwidth_statistics(timespan=4)
if ! res.object.nil?

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

@@ -22,15 +22,12 @@ Querying status of updates
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.updater.get_update_status()
if ! res.object.nil?
@@ -54,15 +51,12 @@ Checking for updates
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)
if res.status_code == 200
@@ -93,15 +87,12 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)
if res.status_code == 200

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

@@ -16,10 +16,8 @@ Get list of all users that are friends and have library access with the provided
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetUsersRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
@@ -35,7 +33,7 @@ req = ::PlexRubySDK::Operations::GetUsersRequest.new(
platform_version: "4.3 build 1057",
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.users.get_users(req)
if ! res.body.nil?

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

@@ -20,14 +20,11 @@ Get the timeline for a media item
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetTimelineRequest.new(
rating_key: 23409.0,
@@ -41,7 +38,7 @@ req = ::PlexRubySDK::Operations::GetTimelineRequest.new(
play_back_time: 2000.0,
row: 1.0,
)
res = s.video.get_timeline(req)
if res.status_code == 200
@@ -71,14 +68,11 @@ Begin a Universal Transcode Session
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(
has_mde: 1.0,
@@ -98,7 +92,7 @@ req = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(
add_debug_overlay: 0.0,
auto_adjust_quality: 0.0,
)
res = s.video.start_universal_transcode(req)
if res.status_code == 200

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

@@ -19,14 +19,11 @@ Get User Watchlist
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
s.config_security(
::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
s = ::PlexRubySDK::PlexAPI.new(
security: ::PlexRubySDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
),
)
req = ::PlexRubySDK::Operations::GetWatchListRequest.new(
filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,
@@ -34,7 +31,7 @@ req = ::PlexRubySDK::Operations::GetWatchListRequest.new(
x_plex_container_size: 50,
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.watchlist.get_watch_list(req)
if ! res.object.nil?