ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.0

This commit is contained in:
speakeasybot
2024-05-08 18:15:54 +00:00
parent 1ad1cf14c8
commit f2c950aa9a
24 changed files with 428 additions and 409 deletions

View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f
management:
docChecksum: 7a43cd3413d535205cfaee20a4b6a250
docChecksum: 543cb95355401d2e3c2ba11a50d9dd94
docVersion: 0.0.3
speakeasyVersion: 1.277.8
generationVersion: 2.319.10
releaseVersion: 0.1.3
configChecksum: 614b6622bf86a573aefbae0930e8abb5
speakeasyVersion: 1.285.0
generationVersion: 2.326.3
releaseVersion: 0.1.4
configChecksum: d28c70e32f445a1ec51cf7d37fe85327
repoURL: https://github.com/LukeHagar/plexruby.git
repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexruby

View File

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

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.283.1
speakeasyVersion: 1.285.0
sources:
my-source: {}
targets:

View File

@@ -1,7 +1,7 @@
PATH
remote: .
specs:
plexruby (0.1.3)
plexruby (0.1.4)
faraday
faraday-multipart
rack

View File

@@ -190,4 +190,12 @@ Based on:
- OpenAPI Doc
- Speakeasy CLI 1.283.1 (2.324.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.1.3] .
- [ruby v0.1.3] .
## 2024-05-08 18:14:59
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.0 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.1.4] .

View File

@@ -3,348 +3,60 @@ info:
title: CodeSamples overlay for ruby target
version: 0.0.0
actions:
- target: $["paths"]["/"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerCapabilities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_capabilities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: cancelServerActivities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.perform_voice_search(query=\"dead+poop\", section_id=4094.8, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSearchResults
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_search_results(query=\"110\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMetadataChildren
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_metadata_children(rating_key=1539.14)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/updater/apply"]["put"]
update:
x-codeSamples:
- lang: ruby
label: applyUpdates
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.apply_updates(tonight=::OpenApiSDK::Operations::Tonight::ONE, skip=::OpenApiSDK::Operations::Skip::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopAllTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: deleteLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.delete_library(section_id=1000.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}/refresh"]["get"]
update:
x-codeSamples:
- lang: ruby
label: refreshLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.refresh_library(section_id=934.16)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log/networked"]["get"]
update:
x-codeSamples:
- lang: ruby
label: enablePaperTrail
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.enable_paper_trail()\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlist_contents(playlist_id=5004.46, type=9403.59)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/prefs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerPreferences
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_preferences()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getButlerTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_butler_tasks()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getRecentlyAdded
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_recently_added()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/pins"]["post"]
update:
x-codeSamples:
- lang: ruby
label: getPin
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.get_pin(strong=false, x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startAllTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}/{tag}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibraryItems
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library_items(section_id=451092, tag=::OpenApiSDK::Operations::Tag::UNWATCHED)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/pins/{pinID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getToken
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.get_token(pin_id=\"<value>\", x_plex_client_identifier=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlist(playlist_id=4109.48)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["put"]
update:
x-codeSamples:
- lang: ruby
label: updatePlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/myplex/account"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMyPlexAccount
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_my_plex_account()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/unscrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markUnplayed
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getGlobalHubs
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_global_hubs(count=1262.49, only_transient=::OpenApiSDK::Operations::OnlyTransient::ONE)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/updater/check"]["put"]
update:
x-codeSamples:
- lang: ruby
label: checkForUpdates
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.check_for_updates(download=::OpenApiSDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log"]["post"]
update:
x-codeSamples:
- lang: ruby
label: logMultiLine
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::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_multi_line(req)\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
update:
x-codeSamples:
- lang: ruby
label: startUniversalTranscode
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::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.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/photo/:/transcode"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getResizedPhoto
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 4000.0,\n min_size: ::OpenApiSDK::Operations::MinSize::ZERO,\n upscale: ::OpenApiSDK::Operations::Upscale::ZERO,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/timeline"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTimeline
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::OpenApiSDK::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.get_timeline(req)\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=::OpenApiSDK::Operations::QueryParamOnlyTransient::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/hashes"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getFileHash
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.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"]["/:/progress"]["post"]
update:
x-codeSamples:
- lang: ruby
label: updatePlayProgress
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.update_play_progress(key=\"<value>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMetadata
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_metadata(rating_key=8382.31)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessions
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
update:
x-codeSamples:
- lang: ruby
label: addPlaylistContents
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.add_playlist_contents(playlist_id=8502.01, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/security/resources"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSourceConnectionInformation
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library(section_id=1000.0, include_details=::OpenApiSDK::Operations::IncludeDetails::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getOnDeck
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_on_deck()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/log"]["get"]
update:
x-codeSamples:
- lang: ruby
label: logLine
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log_line(level=::OpenApiSDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/servers"]["get"]
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerList
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_list()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists"]["post"]
label: startUniversalTranscode
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::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.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: createPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::OpenApiSDK::Operations::QueryParamType::PHOTO,\n smart: ::OpenApiSDK::Operations::Smart::ONE,\n uri: \"https://inborn-brochure.biz\",\n)\n \nres = s.create_playlist(req)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions/history/all"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessionHistory
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_session_history()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/updater/status"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getUpdateStatus
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_update_status()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/clients"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getAvailableClients
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_available_clients()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/activities"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerActivities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_activities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopTask
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.stop_task(task_name=::OpenApiSDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibraries
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_libraries()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/upload"]["post"]
update:
x-codeSamples:
- lang: ruby
label: uploadPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::OpenApiSDK::Operations::Force::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startTask
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.start_task(task_name=::OpenApiSDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylists
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlists(playlist_type=::OpenApiSDK::Operations::PlaylistType::AUDIO, smart=::OpenApiSDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/security/token"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTransientToken
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_transient_token(type=::OpenApiSDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::OpenApiSDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/transcode/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTranscodeSessions
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_transcode_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/devices"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getDevices
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_devices()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/identity"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerIdentity
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_identity()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/scrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markPlayed
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
label: stopAllTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: performSearch
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.perform_search(query=\"dylan\", section_id=1516.53, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getRecentlyAdded
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_recently_added()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: searchLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search_library(section_id=933505, type=::OpenApiSDK::Operations::Type::FOUR)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMetadata
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_metadata(rating_key=8382.31)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
update:
x-codeSamples:
@@ -357,9 +69,297 @@ actions:
- lang: ruby
label: getStatistics
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_statistics(timespan=4)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/prefs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerPreferences
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_preferences()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/unscrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markUnplayed
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}/refresh"]["get"]
update:
x-codeSamples:
- lang: ruby
label: refreshLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.refresh_library(section_id=934.16)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists"]["post"]
update:
x-codeSamples:
- lang: ruby
label: createPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::OpenApiSDK::Operations::QueryParamType::PHOTO,\n smart: ::OpenApiSDK::Operations::Smart::ONE,\n uri: \"https://inborn-brochure.biz\",\n)\n \nres = s.create_playlist(req)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/security/token"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTransientToken
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_transient_token(type=::OpenApiSDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::OpenApiSDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/scrobble"]["get"]
update:
x-codeSamples:
- lang: ruby
label: markPlayed
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/security/resources"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSourceConnectionInformation
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_source_connection_information(source=\"server://client-identifier\")\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=::OpenApiSDK::Operations::QueryParamOnlyTransient::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/log"]["post"]
update:
x-codeSamples:
- lang: ruby
label: logMultiLine
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::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_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylists
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlists(playlist_type=::OpenApiSDK::Operations::PlaylistType::AUDIO, smart=::OpenApiSDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
update:
x-codeSamples:
- lang: ruby
label: addPlaylistContents
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.add_playlist_contents(playlist_id=8502.01, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/updater/status"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getUpdateStatus
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_update_status()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getGlobalHubs
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_global_hubs(count=1262.49, only_transient=::OpenApiSDK::Operations::OnlyTransient::ONE)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/log/networked"]["get"]
update:
x-codeSamples:
- lang: ruby
label: enablePaperTrail
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/apply"]["put"]
update:
x-codeSamples:
- lang: ruby
label: applyUpdates
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.apply_updates(tonight=::OpenApiSDK::Operations::Tonight::ONE, skip=::OpenApiSDK::Operations::Skip::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/devices"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getDevices
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_devices()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/search"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSearchResults
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_search_results(query=\"110\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getOnDeck
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_on_deck()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/servers"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerList
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_list()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/timeline"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTimeline
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::OpenApiSDK::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.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library(section_id=1000.0, include_details=::OpenApiSDK::Operations::IncludeDetails::ZERO)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlist(playlist_id=4109.48)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getButlerTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_butler_tasks()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startTask
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.start_task(task_name=::OpenApiSDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibraries
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_libraries()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/pins"]["post"]
update:
x-codeSamples:
- lang: ruby
label: getPin
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.get_pin(strong=false, x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/pins/{pinID}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getToken
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.get_token(pin_id=\"<value>\", x_plex_client_identifier=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["put"]
update:
x-codeSamples:
- lang: ruby
label: updatePlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\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 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_playlist_contents(playlist_id=5004.46, type=9403.59)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: clearPlaylistContents
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopTranscodeSession
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerCapabilities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_capabilities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/clients"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getAvailableClients
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_available_clients()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessions
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/myplex/account"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMyPlexAccount
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_my_plex_account()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: stopTask
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.stop_task(task_name=::OpenApiSDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getMetadataChildren
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_metadata_children(rating_key=1539.14)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/identity"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerIdentity
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_identity()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/:/progress"]["post"]
update:
x-codeSamples:
- lang: ruby
label: updatePlayProgress
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.update_play_progress(key=\"<value>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/check"]["put"]
update:
x-codeSamples:
- lang: ruby
label: checkForUpdates
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.check_for_updates(download=::OpenApiSDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["post"]
update:
x-codeSamples:
- lang: ruby
label: startAllTasks
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/transcode/sessions"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getTranscodeSessions
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_transcode_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/activities"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getServerActivities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_server_activities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/search/voice"]["get"]
update:
x-codeSamples:
- lang: ruby
label: performVoiceSearch
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.perform_voice_search(query=\"dead+poop\", section_id=4094.8, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: deleteLibrary
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.delete_library(section_id=1000.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/status/sessions/history/all"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getSessionHistory
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_session_history()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
update:
x-codeSamples:
- lang: ruby
label: cancelServerActivities
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionId}/{tag}"]["get"]
update:
x-codeSamples:
- lang: ruby
label: getLibraryItems
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.get_library_items(section_id=\"<value>\", tag=::OpenApiSDK::Operations::Tag::GENRE)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/upload"]["post"]
update:
x-codeSamples:
- lang: ruby
label: uploadPlaylist
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::OpenApiSDK::Operations::Force::ZERO)\n\nif res.status_code == 200\n # handle response\nend"

View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [T.nilable(::OpenApiSDK::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 |
| `skip` | [T.nilable(::OpenApiSDK::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`. |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [T.nilable(::OpenApiSDK::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(::OpenApiSDK::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 |

View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `activity_uuid` | *::String* | :heavy_check_mark: | The UUID of the activity to cancel. |
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activity_uuid` | *::String* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |

View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `download` | [T.nilable(::OpenApiSDK::Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `download` | [T.nilable(::OpenApiSDK::Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Integer* | :heavy_check_mark: | the Id of the library to query |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |

View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `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 |

View File

@@ -3,15 +3,15 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | The rating key of the media item |
| `key` | *::String* | :heavy_check_mark: | The key of the media item to get the timeline for |
| `state` | [::OpenApiSDK::Operations::State](../../models/operations/state.md) | :heavy_check_mark: | The state of the media item |
| `has_mde` | *::Float* | :heavy_check_mark: | Whether the media item has MDE |
| `time` | *::Float* | :heavy_check_mark: | The time of the media item |
| `duration` | *::Float* | :heavy_check_mark: | The duration of the media item |
| `context` | *::String* | :heavy_check_mark: | The context of the media item |
| `play_queue_item_id` | *::Float* | :heavy_check_mark: | The play queue item ID of the media item |
| `play_back_time` | *::Float* | :heavy_check_mark: | The playback time of the media item |
| `row` | *::Float* | :heavy_check_mark: | The row of the media item |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `rating_key` | *::Float* | :heavy_check_mark: | The rating key of the media item | 23409 |
| `key` | *::String* | :heavy_check_mark: | The key of the media item to get the timeline for | /library/metadata/23409 |
| `state` | [::OpenApiSDK::Operations::State](../../models/operations/state.md) | :heavy_check_mark: | The state of the media item | playing |
| `has_mde` | *::Float* | :heavy_check_mark: | Whether the media item has MDE | 1 |
| `time` | *::Float* | :heavy_check_mark: | The time of the media item | 2000 |
| `duration` | *::Float* | :heavy_check_mark: | The duration of the media item | 10000 |
| `context` | *::String* | :heavy_check_mark: | The context of the media item | home:hub.continueWatching |
| `play_queue_item_id` | *::Float* | :heavy_check_mark: | The play queue item ID of the media item | 1 |
| `play_back_time` | *::Float* | :heavy_check_mark: | The playback time of the media item | 2000 |
| `row` | *::Float* | :heavy_check_mark: | The row of the media item | 1 |

View File

@@ -3,21 +3,21 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `has_mde` | *::Float* | :heavy_check_mark: | Whether the media item has MDE |
| `path` | *::String* | :heavy_check_mark: | The path to the media item to transcode |
| `media_index` | *::Float* | :heavy_check_mark: | The index of the media item to transcode |
| `part_index` | *::Float* | :heavy_check_mark: | The index of the part to transcode |
| `protocol` | *::String* | :heavy_check_mark: | The protocol to use for the transcode session |
| `fast_seek` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use fast seek or not |
| `direct_play` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use direct play or not |
| `direct_stream` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use direct stream or not |
| `subtitle_size` | *T.nilable(::Float)* | :heavy_minus_sign: | The size of the subtitles |
| `subtites` | *T.nilable(::String)* | :heavy_minus_sign: | The subtitles |
| `audio_boost` | *T.nilable(::Float)* | :heavy_minus_sign: | The audio boost |
| `location` | *T.nilable(::String)* | :heavy_minus_sign: | The location of the transcode session |
| `media_buffer_size` | *T.nilable(::Float)* | :heavy_minus_sign: | The size of the media buffer |
| `session` | *T.nilable(::String)* | :heavy_minus_sign: | The session ID |
| `add_debug_overlay` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to add a debug overlay or not |
| `auto_adjust_quality` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to auto adjust quality or not |
| Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| `has_mde` | *::Float* | :heavy_check_mark: | Whether the media item has MDE | 1 |
| `path` | *::String* | :heavy_check_mark: | The path to the media item to transcode | /library/metadata/23409 |
| `media_index` | *::Float* | :heavy_check_mark: | The index of the media item to transcode | 0 |
| `part_index` | *::Float* | :heavy_check_mark: | The index of the part to transcode | 0 |
| `protocol` | *::String* | :heavy_check_mark: | The protocol to use for the transcode session | hls |
| `fast_seek` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use fast seek or not | 0 |
| `direct_play` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use direct play or not | 0 |
| `direct_stream` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to use direct stream or not | 0 |
| `subtitle_size` | *T.nilable(::Float)* | :heavy_minus_sign: | The size of the subtitles | 100 |
| `subtites` | *T.nilable(::String)* | :heavy_minus_sign: | The subtitles | burn |
| `audio_boost` | *T.nilable(::Float)* | :heavy_minus_sign: | The audio boost | 100 |
| `location` | *T.nilable(::String)* | :heavy_minus_sign: | The location of the transcode session | lan |
| `media_buffer_size` | *T.nilable(::Float)* | :heavy_minus_sign: | The size of the media buffer | 102400 |
| `session` | *T.nilable(::String)* | :heavy_minus_sign: | The session ID | zvcage8b7rkioqcm8f4uns4c |
| `add_debug_overlay` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to add a debug overlay or not | 0 |
| `auto_adjust_quality` | *T.nilable(::Float)* | :heavy_minus_sign: | Whether to auto adjust quality or not | 0 |

View File

@@ -3,8 +3,8 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | the media key |
| `time` | *::Float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. |
| `state` | *::String* | :heavy_check_mark: | The playback state of the media item. |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | the media key | |
| `time` | *::Float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `state` | *::String* | :heavy_check_mark: | The playback state of the media item. | played |

View File

@@ -71,7 +71,7 @@ s.config_security(
)
res = s.activities.cancel_server_activities(activity_uuid="<value>")
res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e")
if res.status_code == 200
# handle response
@@ -81,9 +81,9 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `activity_uuid` | *::String* | :heavy_check_mark: | The UUID of the activity to cancel. |
| Parameter | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activity_uuid` | *::String* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |
### Response

View File

@@ -296,7 +296,7 @@ s.config_security(
)
res = s.library.get_library_items(section_id=451092, tag=::OpenApiSDK::Operations::Tag::UNWATCHED)
res = s.library.get_library_items(section_id="<value>", tag=::OpenApiSDK::Operations::Tag::GENRE)
if ! res.object.nil?
# handle response
@@ -308,7 +308,7 @@ end
| Parameter | Type | Required | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| `section_id` | *::Integer* | :heavy_check_mark: | the Id of the library to query |
| `section_id` | *::Object* | :heavy_check_mark: | the Id of the library to query |
| `tag` | [::OpenApiSDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. |

View File

@@ -113,7 +113,7 @@ s.config_security(
)
res = s.media.update_play_progress(key="<value>", time=6900.91, state="<value>")
res = s.media.update_play_progress(key="<value>", time=90000.0, state="played")
if res.status_code == 200
# handle response
@@ -123,11 +123,11 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | the media key |
| `time` | *::Float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. |
| `state` | *::String* | :heavy_check_mark: | The playback state of the media item. |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | the media key | |
| `time` | *::Float* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `state` | *::String* | :heavy_check_mark: | The playback state of the media item. | played |
### Response

View File

@@ -30,7 +30,7 @@ s.config_security(
)
res = s.statistics.get_statistics(timespan=411769)
res = s.statistics.get_statistics(timespan=4)
if ! res.two_hundred_application_json_object.nil?
# handle response
@@ -40,9 +40,9 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *::Integer* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> |
| 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 |
### Response

View File

@@ -77,9 +77,9 @@ end
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `download` | [::OpenApiSDK::Operations::Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `download` | [::OpenApiSDK::Operations::Download](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
@@ -118,10 +118,10 @@ end
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [::OpenApiSDK::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 |
| `skip` | [::OpenApiSDK::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`. |
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [::OpenApiSDK::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` | [::OpenApiSDK::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

View File

@@ -32,16 +32,16 @@ s.config_security(
req = ::OpenApiSDK::Operations::GetTimelineRequest.new(
rating_key: 716.56,
key: "<key>",
state: ::OpenApiSDK::Operations::State::PAUSED,
has_mde: 7574.33,
time: 3327.51,
duration: 7585.39,
context: "<value>",
play_queue_item_id: 1406.21,
play_back_time: 2699.34,
row: 3536.42,
rating_key: 23409.0,
key: "/library/metadata/23409",
state: ::OpenApiSDK::Operations::State::PLAYING,
has_mde: 1.0,
time: 2000.0,
duration: 10000.0,
context: "home:hub.continueWatching",
play_queue_item_id: 1.0,
play_back_time: 2000.0,
row: 1.0,
)
res = s.video.get_timeline(req)
@@ -85,11 +85,22 @@ s.config_security(
req = ::OpenApiSDK::Operations::StartUniversalTranscodeRequest.new(
has_mde: 8924.99,
path: "/etc/mail",
media_index: 9962.95,
part_index: 1232.82,
protocol: "<value>",
has_mde: 1.0,
path: "/library/metadata/23409",
media_index: 0.0,
part_index: 0.0,
protocol: "hls",
fast_seek: 0.0,
direct_play: 0.0,
direct_stream: 0.0,
subtitle_size: 100.0,
subtites: "burn",
audio_boost: 100.0,
location: "lan",
media_buffer_size: 102400.0,
session: "zvcage8b7rkioqcm8f4uns4c",
add_debug_overlay: 0.0,
auto_adjust_quality: 0.0,
)
res = s.video.start_universal_transcode(req)

View File

@@ -271,7 +271,7 @@ module OpenApiSDK
end
sig { params(section_id: ::Integer, tag: ::OpenApiSDK::Operations::Tag).returns(::OpenApiSDK::Operations::GetLibraryItemsResponse) }
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag).returns(::OpenApiSDK::Operations::GetLibraryItemsResponse) }
def get_library_items(section_id, tag)
# get_library_items - Get Library Items
# Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:

View File

@@ -12,12 +12,12 @@ module OpenApiSDK
extend T::Sig
# the Id of the library to query
field :section_id, ::Integer, { 'path_param': { 'field_name': 'sectionId', 'style': 'simple', 'explode': false } }
field :section_id, ::Object, { 'path_param': { 'field_name': 'sectionId', 'style': 'simple', 'explode': false } }
# A key representing a specific tag within the section.
field :tag, ::OpenApiSDK::Operations::Tag, { 'path_param': { 'field_name': 'tag', 'style': 'simple', 'explode': false } }
sig { params(section_id: ::Integer, tag: ::OpenApiSDK::Operations::Tag).void }
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag).void }
def initialize(section_id: nil, tag: nil)
@section_id = section_id
@tag = tag

View File

@@ -42,9 +42,9 @@ module OpenApiSDK
@globals = globals.nil? ? {} : globals
@language = 'ruby'
@openapi_doc_version = '0.0.3'
@sdk_version = '0.1.3'
@gen_version = '2.319.10'
@user_agent = 'speakeasy-sdk/ruby 0.1.3 2.319.10 0.0.3 plexruby'
@sdk_version = '0.1.4'
@gen_version = '2.326.3'
@user_agent = 'speakeasy-sdk/ruby 0.1.4 2.326.3 0.0.3 plexruby'
end
sig { returns([String, T::Hash[Symbol, String]]) }

View File

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
Gem::Specification.new do |s|
s.name = 'plexruby'
s.version = '0.1.3'
s.version = '0.1.4'
s.platform = Gem::Platform::RUBY
s.licenses = ['Apache-2.0']
s.summary = ''