mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.314.2
This commit is contained in:
speakeasybot
@@ -1,18 +1,18 @@
|
||||
lockVersion: 2.0.0
|
||||
id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f
|
||||
management:
|
||||
docChecksum: 37654ea0982ab5e87a9a9576014c9d19
|
||||
docChecksum: e73920abd3a55e8d249592f2e3090574
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: 1.308.1
|
||||
generationVersion: 2.342.6
|
||||
releaseVersion: 0.2.0
|
||||
configChecksum: 1507274669f173a15fcb7c909dcf9110
|
||||
speakeasyVersion: 1.314.2
|
||||
generationVersion: 2.349.6
|
||||
releaseVersion: 0.2.1
|
||||
configChecksum: c2d06e76294cc34856d5d82ec3bd41e3
|
||||
repoURL: https://github.com/LukeHagar/plexruby.git
|
||||
repoSubDirectory: .
|
||||
installationURL: https://github.com/LukeHagar/plexruby
|
||||
features:
|
||||
ruby:
|
||||
core: 3.2.13
|
||||
core: 3.2.14
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.81.6
|
||||
globalServerURLs: 2.82.3
|
||||
@@ -348,6 +348,16 @@ generatedFiles:
|
||||
- lib/open_api_sdk/models/operations/getmetadatachildren_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/getmetadatachildren_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getmetadatachildren_response.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_request.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_genre.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_country.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_guids.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_role.rb
|
||||
- lib/open_api_sdk/models/operations/user.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_metadata.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/gettopwatchedcontent_response.rb
|
||||
- lib/open_api_sdk/models/operations/getondeck_errors.rb
|
||||
- lib/open_api_sdk/models/operations/getondeck_library_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getondeck_stream.rb
|
||||
@@ -451,18 +461,36 @@ generatedFiles:
|
||||
- lib/open_api_sdk/models/operations/getstatistics_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/getstatistics_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getstatistics_response.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_request.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_errors.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_statistics_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/statisticsresources.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getresourcesstatistics_response.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_request.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_errors.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_statistics_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_device.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_account.rb
|
||||
- lib/open_api_sdk/models/operations/statisticsbandwidth.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getbandwidthstatistics_response.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_errors.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_sessions_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_stream.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_part.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_media.rb
|
||||
- lib/open_api_sdk/models/operations/user.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_user.rb
|
||||
- lib/open_api_sdk/models/operations/player.rb
|
||||
- lib/open_api_sdk/models/operations/session.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_metadata.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_mediacontainer.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getsessions_response.rb
|
||||
- lib/open_api_sdk/models/operations/filter.rb
|
||||
- lib/open_api_sdk/models/operations/getsessionhistory_request.rb
|
||||
- lib/open_api_sdk/models/operations/getsessionhistory_errors.rb
|
||||
- lib/open_api_sdk/models/operations/getsessionhistory_sessions_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/getsessionhistory_metadata.rb
|
||||
@@ -496,7 +524,7 @@ generatedFiles:
|
||||
- lib/open_api_sdk/models/operations/applyupdates_errors.rb
|
||||
- lib/open_api_sdk/models/operations/applyupdates_responsebody.rb
|
||||
- lib/open_api_sdk/models/operations/applyupdates_response.rb
|
||||
- lib/open_api_sdk/models/operations/filter.rb
|
||||
- lib/open_api_sdk/models/operations/pathparam_filter.rb
|
||||
- lib/open_api_sdk/models/operations/libtype.rb
|
||||
- lib/open_api_sdk/models/operations/includecollections.rb
|
||||
- lib/open_api_sdk/models/operations/includeexternalmedia.rb
|
||||
@@ -770,6 +798,16 @@ generatedFiles:
|
||||
- docs/models/operations/getmetadatachildrenmediacontainer.md
|
||||
- docs/models/operations/getmetadatachildrenresponsebody.md
|
||||
- docs/models/operations/getmetadatachildrenresponse.md
|
||||
- docs/models/operations/gettopwatchedcontentrequest.md
|
||||
- docs/models/operations/gettopwatchedcontentgenre.md
|
||||
- docs/models/operations/gettopwatchedcontentcountry.md
|
||||
- docs/models/operations/gettopwatchedcontentguids.md
|
||||
- docs/models/operations/gettopwatchedcontentrole.md
|
||||
- docs/models/operations/user.md
|
||||
- docs/models/operations/gettopwatchedcontentmetadata.md
|
||||
- docs/models/operations/gettopwatchedcontentmediacontainer.md
|
||||
- docs/models/operations/gettopwatchedcontentresponsebody.md
|
||||
- docs/models/operations/gettopwatchedcontentresponse.md
|
||||
- docs/models/operations/getondeckerrors.md
|
||||
- docs/models/operations/getondecklibraryresponsebody.md
|
||||
- docs/models/operations/getondeckstream.md
|
||||
@@ -873,18 +911,36 @@ generatedFiles:
|
||||
- docs/models/operations/getstatisticsmediacontainer.md
|
||||
- docs/models/operations/getstatisticsresponsebody.md
|
||||
- docs/models/operations/getstatisticsresponse.md
|
||||
- docs/models/operations/getresourcesstatisticsrequest.md
|
||||
- docs/models/operations/getresourcesstatisticserrors.md
|
||||
- docs/models/operations/getresourcesstatisticsstatisticsresponsebody.md
|
||||
- docs/models/operations/statisticsresources.md
|
||||
- docs/models/operations/getresourcesstatisticsmediacontainer.md
|
||||
- docs/models/operations/getresourcesstatisticsresponsebody.md
|
||||
- docs/models/operations/getresourcesstatisticsresponse.md
|
||||
- docs/models/operations/getbandwidthstatisticsrequest.md
|
||||
- docs/models/operations/getbandwidthstatisticserrors.md
|
||||
- docs/models/operations/getbandwidthstatisticsstatisticsresponsebody.md
|
||||
- docs/models/operations/getbandwidthstatisticsdevice.md
|
||||
- docs/models/operations/getbandwidthstatisticsaccount.md
|
||||
- docs/models/operations/statisticsbandwidth.md
|
||||
- docs/models/operations/getbandwidthstatisticsmediacontainer.md
|
||||
- docs/models/operations/getbandwidthstatisticsresponsebody.md
|
||||
- docs/models/operations/getbandwidthstatisticsresponse.md
|
||||
- docs/models/operations/getsessionserrors.md
|
||||
- docs/models/operations/getsessionssessionsresponsebody.md
|
||||
- docs/models/operations/getsessionsstream.md
|
||||
- docs/models/operations/getsessionspart.md
|
||||
- docs/models/operations/getsessionsmedia.md
|
||||
- docs/models/operations/user.md
|
||||
- docs/models/operations/getsessionsuser.md
|
||||
- docs/models/operations/player.md
|
||||
- docs/models/operations/session.md
|
||||
- docs/models/operations/getsessionsmetadata.md
|
||||
- docs/models/operations/getsessionsmediacontainer.md
|
||||
- docs/models/operations/getsessionsresponsebody.md
|
||||
- docs/models/operations/getsessionsresponse.md
|
||||
- docs/models/operations/filter.md
|
||||
- docs/models/operations/getsessionhistoryrequest.md
|
||||
- docs/models/operations/getsessionhistoryerrors.md
|
||||
- docs/models/operations/getsessionhistorysessionsresponsebody.md
|
||||
- docs/models/operations/getsessionhistorymetadata.md
|
||||
@@ -918,7 +974,7 @@ generatedFiles:
|
||||
- docs/models/operations/applyupdateserrors.md
|
||||
- docs/models/operations/applyupdatesresponsebody.md
|
||||
- docs/models/operations/applyupdatesresponse.md
|
||||
- docs/models/operations/filter.md
|
||||
- docs/models/operations/pathparamfilter.md
|
||||
- docs/models/operations/libtype.md
|
||||
- docs/models/operations/includecollections.md
|
||||
- docs/models/operations/includeexternalmedia.md
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
ruby:
|
||||
version: 0.2.0
|
||||
version: 0.2.1
|
||||
author: LukeHagar
|
||||
description: Ruby Client SDK Generated by Speakeasy
|
||||
imports:
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
speakeasyVersion: 1.308.1
|
||||
speakeasyVersion: 1.314.2
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:5c2694e50c805bcd104bcb6db2601ce3897b82b689c6d61e23c7d564e4890057
|
||||
sourceBlobDigest: sha256:06bfe3cb8d54a54a5f409360ac3525d040838460fbd456568e714603183d7593
|
||||
sourceRevisionDigest: sha256:41b686b2df527d179fe41973b55020a335996e8cdefba00c48dbce777ab1b2dd
|
||||
sourceBlobDigest: sha256:0128724fb92073efa5a1d45b1ebae0655b40fe8bc35a4fa47725ff76519e8c52
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -11,8 +11,8 @@ targets:
|
||||
plexruby:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:5c2694e50c805bcd104bcb6db2601ce3897b82b689c6d61e23c7d564e4890057
|
||||
sourceBlobDigest: sha256:06bfe3cb8d54a54a5f409360ac3525d040838460fbd456568e714603183d7593
|
||||
sourceRevisionDigest: sha256:41b686b2df527d179fe41973b55020a335996e8cdefba00c48dbce777ab1b2dd
|
||||
sourceBlobDigest: sha256:0128724fb92073efa5a1d45b1ebae0655b40fe8bc35a4fa47725ff76519e8c52
|
||||
outLocation: /github/workspace/repo
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
plexruby (0.2.0)
|
||||
plexruby (0.2.1)
|
||||
faraday
|
||||
faraday-multipart
|
||||
rack
|
||||
|
||||
11
README.md
11
README.md
@@ -49,7 +49,7 @@ end
|
||||
|
||||
### [Server](docs/sdks/server/README.md)
|
||||
|
||||
* [get_server_capabilities](docs/sdks/server/README.md#get_server_capabilities) - Server Capabilities
|
||||
* [get_server_capabilities](docs/sdks/server/README.md#get_server_capabilities) - Get Server Capabilities
|
||||
* [get_server_preferences](docs/sdks/server/README.md#get_server_preferences) - Get Server Preferences
|
||||
* [get_available_clients](docs/sdks/server/README.md#get_available_clients) - Get Available Clients
|
||||
* [get_devices](docs/sdks/server/README.md#get_devices) - Get Devices
|
||||
@@ -111,6 +111,7 @@ end
|
||||
* [search_library](docs/sdks/library/README.md#search_library) - Search Library
|
||||
* [get_metadata](docs/sdks/library/README.md#get_metadata) - Get Items Metadata
|
||||
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||
|
||||
### [Log](docs/sdks/log/README.md)
|
||||
@@ -139,6 +140,8 @@ end
|
||||
### [Statistics](docs/sdks/statistics/README.md)
|
||||
|
||||
* [get_statistics](docs/sdks/statistics/README.md#get_statistics) - Get Media Statistics
|
||||
* [get_resources_statistics](docs/sdks/statistics/README.md#get_resources_statistics) - Get Resources Statistics
|
||||
* [get_bandwidth_statistics](docs/sdks/statistics/README.md#get_bandwidth_statistics) - Get Bandwidth Statistics
|
||||
|
||||
### [Sessions](docs/sdks/sessions/README.md)
|
||||
|
||||
@@ -209,18 +212,18 @@ end
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
|
||||
The following global parameter is available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| x_plex_client_identifier | ::String | ✔️ | The unique identifier for the client application
|
||||
| x_plex_client_identifier | ::String | | The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
|
||||
|
||||
@@ -399,3 +399,11 @@ Based on:
|
||||
- Speakeasy CLI 1.308.1 (2.342.6) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [ruby v0.2.0] .
|
||||
|
||||
## 2024-06-22 00:10:41
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.314.2 (2.349.6) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [ruby v0.2.1] .
|
||||
546
codeSamples.yaml
546
codeSamples.yaml
@@ -3,168 +3,24 @@ info:
|
||||
title: CodeSamples overlay for ruby target
|
||||
version: 0.0.0
|
||||
actions:
|
||||
- target: $["paths"]["/"]["get"]
|
||||
- target: $["paths"]["/search"]["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.server.get_server_capabilities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/home"]["get"]
|
||||
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.search.get_search_results(query=\"110\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/log"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getHomeData
|
||||
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.plex.get_home_data()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
||||
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.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"]["/updater/apply"]["put"]
|
||||
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.library.get_metadata_children(rating_key=1539.14)\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.butler.stop_task(task_name=::OpenApiSDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\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.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/library/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.library.refresh_library(section_id=934.16)\n\nif res.status_code == 200\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.authentication.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.sessions.get_transcode_sessions()\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.server.get_server_identity()\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.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\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.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\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.hubs.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"]["/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.playlists.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\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.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\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.butler.start_all_tasks()\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.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getWatchlist
|
||||
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::GetWatchlistRequest.new(\n filter: ::OpenApiSDK::Operations::Filter::RELEASED,\n x_plex_token: \"<value>\",\n)\n \nres = s.watchlist.get_watchlist(req)\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.butler.get_butler_tasks()\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.plex.get_pin(x_plex_product=\"Postman\", strong=false, x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_and_one_application_json_object.nil?\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.library.get_library_items(section_id=\"<value>\", tag=::OpenApiSDK::Operations::Tag::GENRE)\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.server.get_devices()\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.search.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}"]["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.library.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"]["/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.sessions.get_session_history()\n\nif ! res.two_hundred_application_json_object.nil?\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.playlists.create_playlist(req)\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.server.get_server_list()\n\nif ! res.two_hundred_application_json_object.nil?\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.hubs.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"
|
||||
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.updater.apply_updates(tonight=::OpenApiSDK::Operations::Tonight::ONE, skip=::OpenApiSDK::Operations::Skip::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -177,132 +33,156 @@ actions:
|
||||
- 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.library.get_libraries()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
|
||||
- target: $["paths"]["/library/sections/{sectionId}"]["delete"]
|
||||
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.library.get_metadata(rating_key=8382.31)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
|
||||
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.library.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: 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.playlists.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"]["/security/resources"]["get"]
|
||||
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.library.refresh_library(section_id=934.16)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/log"]["post"]
|
||||
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.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
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.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/butler"]["post"]
|
||||
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.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/butler/{taskName}"]["post"]
|
||||
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.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/devices"]["get"]
|
||||
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.butler.start_task(task_name=::OpenApiSDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\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.plex.get_token(pin_id=\"<value>\", x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: deletePlaylist
|
||||
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.playlists.delete_playlist(playlist_id=216.22)\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.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\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.sessions.get_sessions()\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.server.get_available_clients()\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.library.search_library(section_id=933505, type=::OpenApiSDK::Operations::Type::FOUR)\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.server.get_server_preferences()\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.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
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.server.get_devices()\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.media.update_play_progress(key=\"<value>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/butler"]["delete"]
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
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.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
|
||||
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.video.start_universal_transcode(req)\n\nif res.status_code == 200\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.butler.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.butler.start_task(task_name=::OpenApiSDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\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.hubs.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"]["/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.library.get_metadata_children(rating_key=1539.14, include_elements=\"<value>\")\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.library.get_on_deck()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/log/networked"]["get"]
|
||||
- target: $["paths"]["/statistics/resources"]["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.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
label: getResourcesStatistics
|
||||
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.statistics.get_resources_statistics(timespan=4)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/status/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- 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.statistics.get_statistics(timespan=4)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
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.sessions.get_sessions()\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.butler.stop_task(task_name=::OpenApiSDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/library/all/top"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getTopWatchedContent
|
||||
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.library.get_top_watched_content(type=505531, include_guids=1)\n\nif ! res.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.authentication.get_source_connection_information(source=\"server://client-identifier\")\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.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::OpenApiSDK::Operations::Filter.new(), library_section_id=12)\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.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/activities"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getServerActivities
|
||||
source: "require '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.activities.get_server_activities()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/hubs/search"]["get"]
|
||||
- target: $["paths"]["/pins"]["post"]
|
||||
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.search.perform_search(query=\"dylan\", section_id=1516.53, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
|
||||
label: getPin
|
||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.plex.get_pin(x_plex_product=\"Postman\", strong=false, x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_and_one_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/clients"]["get"]
|
||||
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.playlists.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"
|
||||
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.server.get_available_clients()\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.video.get_timeline(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.playlists.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.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/updater/status"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -315,63 +195,201 @@ actions:
|
||||
- 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.updater.check_for_updates(download=::OpenApiSDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/updater/apply"]["put"]
|
||||
- target: $["paths"]["/:/scrobble"]["get"]
|
||||
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.updater.apply_updates(tonight=::OpenApiSDK::Operations::Tonight::ONE, skip=::OpenApiSDK::Operations::Skip::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||
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.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/hubs/search"]["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.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/:/timeline"]["get"]
|
||||
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.search.perform_search(query=\"dylan\", section_id=1516.53, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionId}/search"]["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.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
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.library.search_library(section_id=933505, type=::OpenApiSDK::Operations::Type::FOUR)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/butler"]["delete"]
|
||||
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.playlists.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"]["/search"]["get"]
|
||||
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.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/pins/{pinID}"]["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.search.get_search_results(query=\"110\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionId}"]["delete"]
|
||||
label: getToken
|
||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\n\n \nres = s.plex.get_token(pin_id=\"<value>\", x_plex_client_identifier=\"Postman\")\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/hashes"]["get"]
|
||||
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.library.delete_library(section_id=1000.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/myplex/account"]["get"]
|
||||
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.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
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.server.get_my_plex_account()\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.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"]["/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.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
label: deletePlaylist
|
||||
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.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\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.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::OpenApiSDK::Operations::Force::ZERO)\n\nif res.status_code == 200\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.activities.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.search.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"]["/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.playlists.create_playlist(req)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- 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.statistics.get_statistics(timespan=4)\n\nif ! res.two_hundred_application_json_object.nil?\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.library.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/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.library.get_metadata(rating_key=8382.31)\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.playlists.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.playlists.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"]["/"]["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.server.get_server_capabilities()\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.server.get_my_plex_account()\n\nif ! res.two_hundred_application_json_object.nil?\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.server.get_resized_photo(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.hubs.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"]["/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.playlists.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"]["/library/sections/watchlist/{filter}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getWatchlist
|
||||
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::GetWatchlistRequest.new(\n filter: ::OpenApiSDK::Operations::PathParamFilter::RELEASED,\n x_plex_token: \"<value>\",\n)\n \nres = s.watchlist.get_watchlist(req)\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.server.get_server_preferences()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getBandwidthStatistics
|
||||
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.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/home"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: getHomeData
|
||||
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.plex.get_home_data()\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.log.enable_paper_trail()\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.playlists.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}"]["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.playlists.get_playlist(playlist_id=4109.48)\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.authentication.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"]["/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.server.get_server_identity()\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.server.get_server_list()\n\nif ! res.two_hundred_application_json_object.nil?\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.library.get_library_items(section_id=\"<value>\", tag=::OpenApiSDK::Operations::Tag::GENRE, include_guids=1)\n\nif ! res.two_hundred_application_json_object.nil?\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.sessions.get_transcode_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
# Filter
|
||||
|
||||
Filter
|
||||
Filters content by field and direction/equality
|
||||
(Unknown if viewedAt is the only supported column)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `ALL` | all |
|
||||
| `AVAILABLE` | available |
|
||||
| `RELEASED` | released |
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
15
docs/models/operations/getbandwidthstatisticsaccount.md
Normal file
15
docs/models/operations/getbandwidthstatisticsaccount.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetBandwidthStatisticsAccount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 238960586 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
||||
| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Diane |
|
||||
| `default_audio_language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
|
||||
| `auto_select_audio` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `default_subtitle_language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
|
||||
| `subtitle_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
||||
12
docs/models/operations/getbandwidthstatisticsdevice.md
Normal file
12
docs/models/operations/getbandwidthstatisticsdevice.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetBandwidthStatisticsDevice
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 208 |
|
||||
| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Roku Express |
|
||||
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Roku |
|
||||
| `client_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
|
||||
| `created_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1706470556 |
|
||||
10
docs/models/operations/getbandwidthstatisticserrors.md
Normal file
10
docs/models/operations/getbandwidthstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `device` | T::Array<[::OpenApiSDK::Operations::GetBandwidthStatisticsDevice](../../models/operations/getbandwidthstatisticsdevice.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `account` | T::Array<[::OpenApiSDK::Operations::GetBandwidthStatisticsAccount](../../models/operations/getbandwidthstatisticsaccount.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `statistics_bandwidth` | T::Array<[::OpenApiSDK::Operations::StatisticsBandwidth](../../models/operations/statisticsbandwidth.md)> | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/operations/getbandwidthstatisticsrequest.md
Normal file
8
docs/models/operations/getbandwidthstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetBandwidthStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
12
docs/models/operations/getbandwidthstatisticsresponse.md
Normal file
12
docs/models/operations/getbandwidthstatisticsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetBandwidthStatisticsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponseBody)](../../models/operations/getbandwidthstatisticsresponsebody.md) | :heavy_minus_sign: | Bandwidth Statistics |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsStatisticsResponseBody)](../../models/operations/getbandwidthstatisticsstatisticsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getbandwidthstatisticsresponsebody.md
Normal file
10
docs/models/operations/getbandwidthstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
Bandwidth Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsMediaContainer)](../../models/operations/getbandwidthstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetBandwidthStatisticsErrors](../../models/operations/getbandwidthstatisticserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -9,7 +9,7 @@
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_id` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
|
||||
@@ -3,7 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `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. | |
|
||||
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| `include_elements` | *T.nilable(::String)* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
|
||||
@@ -18,4 +18,4 @@ The Pin
|
||||
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
|
||||
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
|
||||
| `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
|
||||
| `new_registration` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
|
||||
| `new_registration` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/operations/getresourcesstatisticserrors.md
Normal file
10
docs/models/operations/getresourcesstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetResourcesStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `statistics_resources` | T::Array<[::OpenApiSDK::Operations::StatisticsResources](../../models/operations/statisticsresources.md)> | :heavy_minus_sign: | N/A | |
|
||||
8
docs/models/operations/getresourcesstatisticsrequest.md
Normal file
8
docs/models/operations/getresourcesstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetResourcesStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
12
docs/models/operations/getresourcesstatisticsresponse.md
Normal file
12
docs/models/operations/getresourcesstatisticsresponse.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetResourcesStatisticsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `two_hundred_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponseBody)](../../models/operations/getresourcesstatisticsresponsebody.md) | :heavy_minus_sign: | Resource Statistics |
|
||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsStatisticsResponseBody)](../../models/operations/getresourcesstatisticsstatisticsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getresourcesstatisticsresponsebody.md
Normal file
10
docs/models/operations/getresourcesstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsResponseBody
|
||||
|
||||
Resource Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsMediaContainer)](../../models/operations/getresourcesstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# GetResourcesStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::OpenApiSDK::Operations::GetResourcesStatisticsErrors](../../models/operations/getresourcesstatisticserrors.md)> | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/getsessionhistoryrequest.md
Normal file
11
docs/models/operations/getsessionhistoryrequest.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetSessionHistoryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sort` | *T.nilable(::String)* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
|
||||
| `account_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
|
||||
| `filter` | [T.nilable(::OpenApiSDK::Operations::Filter)](../../models/operations/filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
|
||||
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
|
||||
@@ -39,6 +39,6 @@
|
||||
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705543314 |
|
||||
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `media` | T::Array<[::OpenApiSDK::Operations::GetSessionsMedia](../../models/operations/getsessionsmedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `user` | [T.nilable(::OpenApiSDK::Operations::User)](../../models/operations/user.md) | :heavy_minus_sign: | N/A | |
|
||||
| `user` | [T.nilable(::OpenApiSDK::Operations::GetSessionsUser)](../../models/operations/getsessionsuser.md) | :heavy_minus_sign: | N/A | |
|
||||
| `player` | [T.nilable(::OpenApiSDK::Operations::Player)](../../models/operations/player.md) | :heavy_minus_sign: | N/A | |
|
||||
| `session` | [T.nilable(::OpenApiSDK::Operations::Session)](../../models/operations/session.md) | :heavy_minus_sign: | N/A | |
|
||||
10
docs/models/operations/getsessionsuser.md
Normal file
10
docs/models/operations/getsessionsuser.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetSessionsUser
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661 |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Blindkitty38 |
|
||||
10
docs/models/operations/gettopwatchedcontentcountry.md
Normal file
10
docs/models/operations/gettopwatchedcontentcountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 116 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | country=116 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||
10
docs/models/operations/gettopwatchedcontentgenre.md
Normal file
10
docs/models/operations/gettopwatchedcontentgenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 184 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | genre=184 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Thriller |
|
||||
8
docs/models/operations/gettopwatchedcontentguids.md
Normal file
8
docs/models/operations/gettopwatchedcontentguids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetTopWatchedContentGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tvdb://2337 |
|
||||
13
docs/models/operations/gettopwatchedcontentmediacontainer.md
Normal file
13
docs/models/operations/gettopwatchedcontentmediacontainer.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetTopWatchedContentMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentMetadata](../../models/operations/gettopwatchedcontentmetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
39
docs/models/operations/gettopwatchedcontentmetadata.md
Normal file
39
docs/models/operations/gettopwatchedcontentmetadata.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# GetTopWatchedContentMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | waterloo-road |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 222 |
|
||||
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 100 |
|
||||
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 13 |
|
||||
| `added_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `global_view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 80 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `genre` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentGenre](../../models/operations/gettopwatchedcontentgenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentCountry](../../models/operations/gettopwatchedcontentcountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentGuids](../../models/operations/gettopwatchedcontentguids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::OpenApiSDK::Operations::GetTopWatchedContentRole](../../models/operations/gettopwatchedcontentrole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `user` | T::Array<[::OpenApiSDK::Operations::User](../../models/operations/user.md)> | :heavy_minus_sign: | N/A | |
|
||||
9
docs/models/operations/gettopwatchedcontentrequest.md
Normal file
9
docs/models/operations/gettopwatchedcontentrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetTopWatchedContentRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `type` | *::Integer* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
11
docs/models/operations/gettopwatchedcontentresponse.md
Normal file
11
docs/models/operations/gettopwatchedcontentresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetTopWatchedContentResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponseBody)](../../models/operations/gettopwatchedcontentresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
10
docs/models/operations/gettopwatchedcontentresponsebody.md
Normal file
10
docs/models/operations/gettopwatchedcontentresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetTopWatchedContentResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentMediaContainer)](../../models/operations/gettopwatchedcontentmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/gettopwatchedcontentrole.md
Normal file
13
docs/models/operations/gettopwatchedcontentrole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetTopWatchedContentRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | actor=220 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `filter` | [::OpenApiSDK::Operations::Filter](../../models/operations/filter.md) | :heavy_check_mark: | Filter |
|
||||
| `filter` | [::OpenApiSDK::Operations::PathParamFilter](../../models/operations/pathparamfilter.md) | :heavy_check_mark: | Filter |
|
||||
| `sort` | *T.nilable(::String)* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> |
|
||||
| `libtype` | [T.nilable(::OpenApiSDK::Operations::Libtype)](../../models/operations/libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> |
|
||||
| `maxresults` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> |
|
||||
|
||||
12
docs/models/operations/pathparamfilter.md
Normal file
12
docs/models/operations/pathparamfilter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# PathParamFilter
|
||||
|
||||
Filter
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `ALL` | all |
|
||||
| `AVAILABLE` | available |
|
||||
| `RELEASED` | released |
|
||||
13
docs/models/operations/statisticsbandwidth.md
Normal file
13
docs/models/operations/statisticsbandwidth.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# StatisticsBandwidth
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `account_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 238960586 |
|
||||
| `device_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
|
||||
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1718387650 |
|
||||
| `lan` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `bytes` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 22 |
|
||||
13
docs/models/operations/statisticsresources.md
Normal file
13
docs/models/operations/statisticsresources.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# StatisticsResources
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||
| `timespan` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1718384427 |
|
||||
| `host_cpu_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.276 |
|
||||
| `process_cpu_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0.025 |
|
||||
| `host_memory_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 17.026 |
|
||||
| `process_memory_utilization` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0.493 |
|
||||
@@ -3,8 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661 |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Blindkitty38 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |
|
||||
@@ -18,6 +18,7 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [search_library](#search_library) - Search Library
|
||||
* [get_metadata](#get_metadata) - Get Items Metadata
|
||||
* [get_metadata_children](#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](#get_on_deck) - Get On Deck
|
||||
|
||||
## get_file_hash
|
||||
@@ -296,7 +297,7 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_library_items(section_id="<value>", tag=::OpenApiSDK::Operations::Tag::GENRE)
|
||||
res = s.library.get_library_items(section_id="<value>", tag=::OpenApiSDK::Operations::Tag::GENRE, include_guids=1)
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
@@ -306,10 +307,11 @@ end
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `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. | |
|
||||
| `include_guids` | *::Integer* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
|
||||
|
||||
### Response
|
||||
@@ -479,7 +481,7 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_metadata_children(rating_key=1539.14)
|
||||
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="<value>")
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
@@ -489,9 +491,10 @@ end
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `rating_key` | *::Float* | :heavy_check_mark: | the id of the library item to return the children of. |
|
||||
| `include_elements` | *::String* | :heavy_minus_sign: | Adds additional elements to the response. Supported types are (Stream)<br/> |
|
||||
|
||||
|
||||
### Response
|
||||
@@ -499,6 +502,48 @@ end
|
||||
**[T.nilable(::OpenApiSDK::Operations::GetMetadataChildrenResponse)](../../models/operations/getmetadatachildrenresponse.md)**
|
||||
|
||||
|
||||
## get_top_watched_content
|
||||
|
||||
This endpoint will return the top watched content from libraries of a certain type
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require 'plexruby'
|
||||
|
||||
|
||||
s = ::OpenApiSDK::PlexAPI.new(
|
||||
x_plex_client_identifier: "Postman",
|
||||
)
|
||||
s.config_security(
|
||||
::OpenApiSDK::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_top_watched_content(type=505531, include_guids=1)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `type` | *::Integer* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
|
||||
| `include_guids` | *::Integer* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponse)](../../models/operations/gettopwatchedcontentresponse.md)**
|
||||
|
||||
|
||||
## get_on_deck
|
||||
|
||||
This endpoint will return the on deck content.
|
||||
|
||||
@@ -8,7 +8,7 @@ Operations against the Plex Media Server System.
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [get_server_capabilities](#get_server_capabilities) - Server Capabilities
|
||||
* [get_server_capabilities](#get_server_capabilities) - Get Server Capabilities
|
||||
* [get_server_preferences](#get_server_preferences) - Get Server Preferences
|
||||
* [get_available_clients](#get_available_clients) - Get Available Clients
|
||||
* [get_devices](#get_devices) - Get Devices
|
||||
@@ -19,7 +19,7 @@ Operations against the Plex Media Server System.
|
||||
|
||||
## get_server_capabilities
|
||||
|
||||
Server Capabilities
|
||||
Get Server Capabilities
|
||||
|
||||
### Example Usage
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.sessions.get_session_history()
|
||||
res = s.sessions.get_session_history(sort="<value>", account_id=1, filter=::OpenApiSDK::Operations::Filter.new(), library_section_id=12)
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
@@ -75,6 +75,15 @@ end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sort` | *::String* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
|
||||
| `account_id` | *::Integer* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
|
||||
| `filter` | [::OpenApiSDK::Operations::Filter](../../models/operations/filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
|
||||
| `library_section_id` | *::Integer* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -9,6 +9,8 @@ API Calls that perform operations with Plex Media Server Statistics
|
||||
### Available Operations
|
||||
|
||||
* [get_statistics](#get_statistics) - Get Media Statistics
|
||||
* [get_resources_statistics](#get_resources_statistics) - Get Resources Statistics
|
||||
* [get_bandwidth_statistics](#get_bandwidth_statistics) - Get Bandwidth Statistics
|
||||
|
||||
## get_statistics
|
||||
|
||||
@@ -49,3 +51,83 @@ end
|
||||
|
||||
**[T.nilable(::OpenApiSDK::Operations::GetStatisticsResponse)](../../models/operations/getstatisticsresponse.md)**
|
||||
|
||||
|
||||
## get_resources_statistics
|
||||
|
||||
This will return the resources for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require 'plexruby'
|
||||
|
||||
|
||||
s = ::OpenApiSDK::PlexAPI.new(
|
||||
x_plex_client_identifier: "Postman",
|
||||
)
|
||||
s.config_security(
|
||||
::OpenApiSDK::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
res = s.statistics.get_resources_statistics(timespan=4)
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| 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
|
||||
|
||||
**[T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponse)](../../models/operations/getresourcesstatisticsresponse.md)**
|
||||
|
||||
|
||||
## get_bandwidth_statistics
|
||||
|
||||
This will return the bandwidth statistics for the server
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require 'plexruby'
|
||||
|
||||
|
||||
s = ::OpenApiSDK::PlexAPI.new(
|
||||
x_plex_client_identifier: "Postman",
|
||||
)
|
||||
s.config_security(
|
||||
::OpenApiSDK::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
res = s.statistics.get_bandwidth_statistics(timespan=4)
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| 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
|
||||
|
||||
**[T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponse)](../../models/operations/getbandwidthstatisticsresponse.md)**
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ s.config_security(
|
||||
|
||||
|
||||
req = ::OpenApiSDK::Operations::GetWatchlistRequest.new(
|
||||
filter: ::OpenApiSDK::Operations::Filter::RELEASED,
|
||||
filter: ::OpenApiSDK::Operations::PathParamFilter::RELEASED,
|
||||
x_plex_token: "<value>",
|
||||
)
|
||||
|
||||
|
||||
@@ -271,8 +271,8 @@ module OpenApiSDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag).returns(::OpenApiSDK::Operations::GetLibraryItemsResponse) }
|
||||
def get_library_items(section_id, tag)
|
||||
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag, include_guids: T.nilable(::Integer)).returns(::OpenApiSDK::Operations::GetLibraryItemsResponse) }
|
||||
def get_library_items(section_id, tag, include_guids = nil)
|
||||
# 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:
|
||||
# - `all`: All items in the section.
|
||||
@@ -298,7 +298,8 @@ module OpenApiSDK
|
||||
request = ::OpenApiSDK::Operations::GetLibraryItemsRequest.new(
|
||||
|
||||
section_id: section_id,
|
||||
tag: tag
|
||||
tag: tag,
|
||||
include_guids: include_guids
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
@@ -310,11 +311,13 @@ module OpenApiSDK
|
||||
@sdk_configuration.globals
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLibraryItemsRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
@@ -498,14 +501,15 @@ module OpenApiSDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(rating_key: ::Float).returns(::OpenApiSDK::Operations::GetMetadataChildrenResponse) }
|
||||
def get_metadata_children(rating_key)
|
||||
sig { params(rating_key: ::Float, include_elements: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetMetadataChildrenResponse) }
|
||||
def get_metadata_children(rating_key, include_elements = nil)
|
||||
# get_metadata_children - Get Items Children
|
||||
# This endpoint will return the children of of a library item specified with the ratingKey.
|
||||
#
|
||||
request = ::OpenApiSDK::Operations::GetMetadataChildrenRequest.new(
|
||||
|
||||
rating_key: rating_key
|
||||
rating_key: rating_key,
|
||||
include_elements: include_elements
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
@@ -517,11 +521,13 @@ module OpenApiSDK
|
||||
@sdk_configuration.globals
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetMetadataChildrenRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
@@ -546,6 +552,45 @@ module OpenApiSDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(type: ::Integer, include_guids: T.nilable(::Integer)).returns(::OpenApiSDK::Operations::GetTopWatchedContentResponse) }
|
||||
def get_top_watched_content(type, include_guids = nil)
|
||||
# get_top_watched_content - Get Top Watched Content
|
||||
# This endpoint will return the top watched content from libraries of a certain type
|
||||
#
|
||||
request = ::OpenApiSDK::Operations::GetTopWatchedContentRequest.new(
|
||||
|
||||
type: type,
|
||||
include_guids: include_guids
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = "#{base_url}/library/all/top"
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetTopWatchedContentRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
||||
|
||||
res = ::OpenApiSDK::Operations::GetTopWatchedContentResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if r.status == 200
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetTopWatchedContentResponseBody)
|
||||
res.object = out
|
||||
end
|
||||
end
|
||||
res
|
||||
end
|
||||
|
||||
|
||||
sig { returns(::OpenApiSDK::Operations::GetOnDeckResponse) }
|
||||
def get_on_deck
|
||||
# get_on_deck - Get On Deck
|
||||
|
||||
@@ -264,6 +264,16 @@ module OpenApiSDK
|
||||
autoload :GetMetadataChildrenMediaContainer, 'open_api_sdk/models/operations/getmetadatachildren_mediacontainer.rb'
|
||||
autoload :GetMetadataChildrenResponseBody, 'open_api_sdk/models/operations/getmetadatachildren_responsebody.rb'
|
||||
autoload :GetMetadataChildrenResponse, 'open_api_sdk/models/operations/getmetadatachildren_response.rb'
|
||||
autoload :GetTopWatchedContentRequest, 'open_api_sdk/models/operations/gettopwatchedcontent_request.rb'
|
||||
autoload :GetTopWatchedContentGenre, 'open_api_sdk/models/operations/gettopwatchedcontent_genre.rb'
|
||||
autoload :GetTopWatchedContentCountry, 'open_api_sdk/models/operations/gettopwatchedcontent_country.rb'
|
||||
autoload :GetTopWatchedContentGuids, 'open_api_sdk/models/operations/gettopwatchedcontent_guids.rb'
|
||||
autoload :GetTopWatchedContentRole, 'open_api_sdk/models/operations/gettopwatchedcontent_role.rb'
|
||||
autoload :User, 'open_api_sdk/models/operations/user.rb'
|
||||
autoload :GetTopWatchedContentMetadata, 'open_api_sdk/models/operations/gettopwatchedcontent_metadata.rb'
|
||||
autoload :GetTopWatchedContentMediaContainer, 'open_api_sdk/models/operations/gettopwatchedcontent_mediacontainer.rb'
|
||||
autoload :GetTopWatchedContentResponseBody, 'open_api_sdk/models/operations/gettopwatchedcontent_responsebody.rb'
|
||||
autoload :GetTopWatchedContentResponse, 'open_api_sdk/models/operations/gettopwatchedcontent_response.rb'
|
||||
autoload :GetOnDeckErrors, 'open_api_sdk/models/operations/getondeck_errors.rb'
|
||||
autoload :GetOnDeckLibraryResponseBody, 'open_api_sdk/models/operations/getondeck_library_responsebody.rb'
|
||||
autoload :GetOnDeckStream, 'open_api_sdk/models/operations/getondeck_stream.rb'
|
||||
@@ -367,18 +377,36 @@ module OpenApiSDK
|
||||
autoload :GetStatisticsMediaContainer, 'open_api_sdk/models/operations/getstatistics_mediacontainer.rb'
|
||||
autoload :GetStatisticsResponseBody, 'open_api_sdk/models/operations/getstatistics_responsebody.rb'
|
||||
autoload :GetStatisticsResponse, 'open_api_sdk/models/operations/getstatistics_response.rb'
|
||||
autoload :GetResourcesStatisticsRequest, 'open_api_sdk/models/operations/getresourcesstatistics_request.rb'
|
||||
autoload :GetResourcesStatisticsErrors, 'open_api_sdk/models/operations/getresourcesstatistics_errors.rb'
|
||||
autoload :GetResourcesStatisticsStatisticsResponseBody, 'open_api_sdk/models/operations/getresourcesstatistics_statistics_responsebody.rb'
|
||||
autoload :StatisticsResources, 'open_api_sdk/models/operations/statisticsresources.rb'
|
||||
autoload :GetResourcesStatisticsMediaContainer, 'open_api_sdk/models/operations/getresourcesstatistics_mediacontainer.rb'
|
||||
autoload :GetResourcesStatisticsResponseBody, 'open_api_sdk/models/operations/getresourcesstatistics_responsebody.rb'
|
||||
autoload :GetResourcesStatisticsResponse, 'open_api_sdk/models/operations/getresourcesstatistics_response.rb'
|
||||
autoload :GetBandwidthStatisticsRequest, 'open_api_sdk/models/operations/getbandwidthstatistics_request.rb'
|
||||
autoload :GetBandwidthStatisticsErrors, 'open_api_sdk/models/operations/getbandwidthstatistics_errors.rb'
|
||||
autoload :GetBandwidthStatisticsStatisticsResponseBody, 'open_api_sdk/models/operations/getbandwidthstatistics_statistics_responsebody.rb'
|
||||
autoload :GetBandwidthStatisticsDevice, 'open_api_sdk/models/operations/getbandwidthstatistics_device.rb'
|
||||
autoload :GetBandwidthStatisticsAccount, 'open_api_sdk/models/operations/getbandwidthstatistics_account.rb'
|
||||
autoload :StatisticsBandwidth, 'open_api_sdk/models/operations/statisticsbandwidth.rb'
|
||||
autoload :GetBandwidthStatisticsMediaContainer, 'open_api_sdk/models/operations/getbandwidthstatistics_mediacontainer.rb'
|
||||
autoload :GetBandwidthStatisticsResponseBody, 'open_api_sdk/models/operations/getbandwidthstatistics_responsebody.rb'
|
||||
autoload :GetBandwidthStatisticsResponse, 'open_api_sdk/models/operations/getbandwidthstatistics_response.rb'
|
||||
autoload :GetSessionsErrors, 'open_api_sdk/models/operations/getsessions_errors.rb'
|
||||
autoload :GetSessionsSessionsResponseBody, 'open_api_sdk/models/operations/getsessions_sessions_responsebody.rb'
|
||||
autoload :GetSessionsStream, 'open_api_sdk/models/operations/getsessions_stream.rb'
|
||||
autoload :GetSessionsPart, 'open_api_sdk/models/operations/getsessions_part.rb'
|
||||
autoload :GetSessionsMedia, 'open_api_sdk/models/operations/getsessions_media.rb'
|
||||
autoload :User, 'open_api_sdk/models/operations/user.rb'
|
||||
autoload :GetSessionsUser, 'open_api_sdk/models/operations/getsessions_user.rb'
|
||||
autoload :Player, 'open_api_sdk/models/operations/player.rb'
|
||||
autoload :Session, 'open_api_sdk/models/operations/session.rb'
|
||||
autoload :GetSessionsMetadata, 'open_api_sdk/models/operations/getsessions_metadata.rb'
|
||||
autoload :GetSessionsMediaContainer, 'open_api_sdk/models/operations/getsessions_mediacontainer.rb'
|
||||
autoload :GetSessionsResponseBody, 'open_api_sdk/models/operations/getsessions_responsebody.rb'
|
||||
autoload :GetSessionsResponse, 'open_api_sdk/models/operations/getsessions_response.rb'
|
||||
autoload :Filter, 'open_api_sdk/models/operations/filter.rb'
|
||||
autoload :GetSessionHistoryRequest, 'open_api_sdk/models/operations/getsessionhistory_request.rb'
|
||||
autoload :GetSessionHistoryErrors, 'open_api_sdk/models/operations/getsessionhistory_errors.rb'
|
||||
autoload :GetSessionHistorySessionsResponseBody, 'open_api_sdk/models/operations/getsessionhistory_sessions_responsebody.rb'
|
||||
autoload :GetSessionHistoryMetadata, 'open_api_sdk/models/operations/getsessionhistory_metadata.rb'
|
||||
@@ -412,7 +440,7 @@ module OpenApiSDK
|
||||
autoload :ApplyUpdatesErrors, 'open_api_sdk/models/operations/applyupdates_errors.rb'
|
||||
autoload :ApplyUpdatesResponseBody, 'open_api_sdk/models/operations/applyupdates_responsebody.rb'
|
||||
autoload :ApplyUpdatesResponse, 'open_api_sdk/models/operations/applyupdates_response.rb'
|
||||
autoload :Filter, 'open_api_sdk/models/operations/filter.rb'
|
||||
autoload :PathParamFilter, 'open_api_sdk/models/operations/pathparam_filter.rb'
|
||||
autoload :Libtype, 'open_api_sdk/models/operations/libtype.rb'
|
||||
autoload :IncludeCollections, 'open_api_sdk/models/operations/includecollections.rb'
|
||||
autoload :IncludeExternalMedia, 'open_api_sdk/models/operations/includeexternalmedia.rb'
|
||||
|
||||
@@ -6,18 +6,17 @@
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
FILTER_SERVERS = [
|
||||
'https://metadata.provider.plex.tv'
|
||||
].freeze
|
||||
|
||||
# Filter - Filter
|
||||
class Filter < T::Enum
|
||||
enums do
|
||||
ALL = new('all')
|
||||
AVAILABLE = new('available')
|
||||
RELEASED = new('released')
|
||||
end
|
||||
# Filters content by field and direction/equality
|
||||
# (Unknown if viewedAt is the only supported column)
|
||||
#
|
||||
class Filter < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
|
||||
|
||||
def initialize; end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsAccount < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :auto_select_audio, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('autoSelectAudio') } }
|
||||
|
||||
field :default_audio_language, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('defaultAudioLanguage') } }
|
||||
|
||||
field :default_subtitle_language, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('defaultSubtitleLanguage') } }
|
||||
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
||||
|
||||
field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
||||
|
||||
field :subtitle_mode, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('subtitleMode') } }
|
||||
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('thumb') } }
|
||||
|
||||
|
||||
sig { params(auto_select_audio: T.nilable(T::Boolean), default_audio_language: T.nilable(::String), default_subtitle_language: T.nilable(::String), id: T.nilable(::Integer), key: T.nilable(::String), name: T.nilable(::String), subtitle_mode: T.nilable(::Integer), thumb: T.nilable(::String)).void }
|
||||
def initialize(auto_select_audio: nil, default_audio_language: nil, default_subtitle_language: nil, id: nil, key: nil, name: nil, subtitle_mode: nil, thumb: nil)
|
||||
@auto_select_audio = auto_select_audio
|
||||
@default_audio_language = default_audio_language
|
||||
@default_subtitle_language = default_subtitle_language
|
||||
@id = id
|
||||
@key = key
|
||||
@name = name
|
||||
@subtitle_mode = subtitle_mode
|
||||
@thumb = thumb
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,36 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsDevice < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :client_identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clientIdentifier') } }
|
||||
|
||||
field :created_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt') } }
|
||||
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
||||
|
||||
field :platform, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('platform') } }
|
||||
|
||||
|
||||
sig { params(client_identifier: T.nilable(::String), created_at: T.nilable(::Integer), id: T.nilable(::Integer), name: T.nilable(::String), platform: T.nilable(::String)).void }
|
||||
def initialize(client_identifier: nil, created_at: nil, id: nil, name: nil, platform: nil)
|
||||
@client_identifier = client_identifier
|
||||
@created_at = created_at
|
||||
@id = id
|
||||
@name = name
|
||||
@platform = platform
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsErrors < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :code, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('code') } }
|
||||
|
||||
field :message, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('message') } }
|
||||
|
||||
field :status, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status') } }
|
||||
|
||||
|
||||
sig { params(code: T.nilable(::Float), message: T.nilable(::String), status: T.nilable(::Float)).void }
|
||||
def initialize(code: nil, message: nil, status: nil)
|
||||
@code = code
|
||||
@message = message
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,33 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsMediaContainer < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :account, T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsAccount]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Account') } }
|
||||
|
||||
field :device, T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsDevice]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Device') } }
|
||||
|
||||
field :size, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('size') } }
|
||||
|
||||
field :statistics_bandwidth, T.nilable(T::Array[::OpenApiSDK::Operations::StatisticsBandwidth]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('StatisticsBandwidth') } }
|
||||
|
||||
|
||||
sig { params(account: T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsAccount]), device: T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsDevice]), size: T.nilable(::Integer), statistics_bandwidth: T.nilable(T::Array[::OpenApiSDK::Operations::StatisticsBandwidth])).void }
|
||||
def initialize(account: nil, device: nil, size: nil, statistics_bandwidth: nil)
|
||||
@account = account
|
||||
@device = device
|
||||
@size = size
|
||||
@statistics_bandwidth = statistics_bandwidth
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,26 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsRequest < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The timespan to retrieve statistics for
|
||||
# the exact meaning of this parameter is not known
|
||||
#
|
||||
field :timespan, T.nilable(::Integer), { 'query_param': { 'field_name': 'Timespan', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(timespan: T.nilable(::Integer)).void }
|
||||
def initialize(timespan: nil)
|
||||
@timespan = timespan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,36 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetBandwidthStatisticsResponse < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# HTTP response content type for this operation
|
||||
field :content_type, ::String
|
||||
# Raw HTTP response; suitable for custom response parsing
|
||||
field :raw_response, ::Faraday::Response
|
||||
# HTTP response status code for this operation
|
||||
field :status_code, ::Integer
|
||||
# Bandwidth Statistics
|
||||
field :two_hundred_application_json_object, T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponseBody)
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
field :four_hundred_and_one_application_json_object, T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsStatisticsResponseBody)
|
||||
|
||||
|
||||
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, two_hundred_application_json_object: T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsResponseBody), four_hundred_and_one_application_json_object: T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsStatisticsResponseBody)).void }
|
||||
def initialize(content_type: nil, raw_response: nil, status_code: nil, two_hundred_application_json_object: nil, four_hundred_and_one_application_json_object: nil)
|
||||
@content_type = content_type
|
||||
@raw_response = raw_response
|
||||
@status_code = status_code
|
||||
@two_hundred_application_json_object = two_hundred_application_json_object
|
||||
@four_hundred_and_one_application_json_object = four_hundred_and_one_application_json_object
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
# Bandwidth Statistics
|
||||
class GetBandwidthStatisticsResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :media_container, T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsMediaContainer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('MediaContainer') } }
|
||||
|
||||
|
||||
sig { params(media_container: T.nilable(::OpenApiSDK::Operations::GetBandwidthStatisticsMediaContainer)).void }
|
||||
def initialize(media_container: nil)
|
||||
@media_container = media_container
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
class GetBandwidthStatisticsStatisticsResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :errors, T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsErrors]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('errors') } }
|
||||
|
||||
|
||||
sig { params(errors: T.nilable(T::Array[::OpenApiSDK::Operations::GetBandwidthStatisticsErrors])).void }
|
||||
def initialize(errors: nil)
|
||||
@errors = errors
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -18,7 +18,7 @@ module OpenApiSDK
|
||||
|
||||
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
||||
|
||||
field :library_section_id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionID') } }
|
||||
field :library_section_id, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionID') } }
|
||||
|
||||
field :library_section_title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionTitle') } }
|
||||
|
||||
@@ -45,7 +45,7 @@ module OpenApiSDK
|
||||
field :view_mode, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('viewMode') } }
|
||||
|
||||
|
||||
sig { params(allow_sync: T.nilable(T::Boolean), art: T.nilable(::String), identifier: T.nilable(::String), library_section_id: T.nilable(::Integer), library_section_title: T.nilable(::String), library_section_uuid: T.nilable(::String), media_tag_prefix: T.nilable(::String), media_tag_version: T.nilable(::Integer), metadata: T.nilable(T::Array[::OpenApiSDK::Operations::GetLibraryItemsMetadata]), mixed_parents: T.nilable(T::Boolean), size: T.nilable(::Integer), thumb: T.nilable(::String), title1: T.nilable(::String), title2: T.nilable(::String), view_group: T.nilable(::String), view_mode: T.nilable(::Integer)).void }
|
||||
sig { params(allow_sync: T.nilable(T::Boolean), art: T.nilable(::String), identifier: T.nilable(::String), library_section_id: T.nilable(::Object), library_section_title: T.nilable(::String), library_section_uuid: T.nilable(::String), media_tag_prefix: T.nilable(::String), media_tag_version: T.nilable(::Integer), metadata: T.nilable(T::Array[::OpenApiSDK::Operations::GetLibraryItemsMetadata]), mixed_parents: T.nilable(T::Boolean), size: T.nilable(::Integer), thumb: T.nilable(::String), title1: T.nilable(::String), title2: T.nilable(::String), view_group: T.nilable(::String), view_mode: T.nilable(::Integer)).void }
|
||||
def initialize(allow_sync: nil, art: nil, identifier: nil, library_section_id: nil, library_section_title: nil, library_section_uuid: nil, media_tag_prefix: nil, media_tag_version: nil, metadata: nil, mixed_parents: nil, size: nil, thumb: nil, title1: nil, title2: nil, view_group: nil, view_mode: nil)
|
||||
@allow_sync = allow_sync
|
||||
@art = art
|
||||
|
||||
@@ -15,12 +15,16 @@ module OpenApiSDK
|
||||
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 } }
|
||||
# Adds the Guids object to the response
|
||||
#
|
||||
field :include_guids, T.nilable(::Integer), { 'query_param': { 'field_name': 'includeGuids', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag).void }
|
||||
def initialize(section_id: nil, tag: nil)
|
||||
sig { params(section_id: ::Object, tag: ::OpenApiSDK::Operations::Tag, include_guids: T.nilable(::Integer)).void }
|
||||
def initialize(section_id: nil, tag: nil, include_guids: nil)
|
||||
@section_id = section_id
|
||||
@tag = tag
|
||||
@include_guids = include_guids
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -13,11 +13,15 @@ module OpenApiSDK
|
||||
|
||||
# the id of the library item to return the children of.
|
||||
field :rating_key, ::Float, { 'path_param': { 'field_name': 'ratingKey', 'style': 'simple', 'explode': false } }
|
||||
# Adds additional elements to the response. Supported types are (Stream)
|
||||
#
|
||||
field :include_elements, T.nilable(::String), { 'query_param': { 'field_name': 'includeElements', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(rating_key: ::Float).void }
|
||||
def initialize(rating_key: nil)
|
||||
sig { params(rating_key: ::Float, include_elements: T.nilable(::String)).void }
|
||||
def initialize(rating_key: nil, include_elements: nil)
|
||||
@rating_key = rating_key
|
||||
@include_elements = include_elements
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -31,7 +31,7 @@ module OpenApiSDK
|
||||
|
||||
field :location, T.nilable(::OpenApiSDK::Operations::Location), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('location') } }
|
||||
|
||||
field :new_registration, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('newRegistration') } }
|
||||
field :new_registration, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('newRegistration') } }
|
||||
|
||||
field :product, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('product') } }
|
||||
# a link to a QR code hosted on plex.tv
|
||||
@@ -43,7 +43,7 @@ module OpenApiSDK
|
||||
field :trusted, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trusted') } }
|
||||
|
||||
|
||||
sig { params(auth_token: T.nilable(::String), client_identifier: T.nilable(::String), code: T.nilable(::String), created_at: T.nilable(::DateTime), expires_at: T.nilable(::DateTime), expires_in: T.nilable(::Float), id: T.nilable(::Float), location: T.nilable(::OpenApiSDK::Operations::Location), new_registration: T.nilable(::String), product: T.nilable(::String), qr: T.nilable(::String), trusted: T.nilable(T::Boolean)).void }
|
||||
sig { params(auth_token: T.nilable(::String), client_identifier: T.nilable(::String), code: T.nilable(::String), created_at: T.nilable(::DateTime), expires_at: T.nilable(::DateTime), expires_in: T.nilable(::Float), id: T.nilable(::Float), location: T.nilable(::OpenApiSDK::Operations::Location), new_registration: T.nilable(T::Boolean), product: T.nilable(::String), qr: T.nilable(::String), trusted: T.nilable(T::Boolean)).void }
|
||||
def initialize(auth_token: nil, client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, new_registration: nil, product: nil, qr: nil, trusted: nil)
|
||||
@auth_token = auth_token
|
||||
@client_identifier = client_identifier
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetResourcesStatisticsErrors < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :code, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('code') } }
|
||||
|
||||
field :message, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('message') } }
|
||||
|
||||
field :status, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status') } }
|
||||
|
||||
|
||||
sig { params(code: T.nilable(::Float), message: T.nilable(::String), status: T.nilable(::Float)).void }
|
||||
def initialize(code: nil, message: nil, status: nil)
|
||||
@code = code
|
||||
@message = message
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,27 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetResourcesStatisticsMediaContainer < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :size, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('size') } }
|
||||
|
||||
field :statistics_resources, T.nilable(T::Array[::OpenApiSDK::Operations::StatisticsResources]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('StatisticsResources') } }
|
||||
|
||||
|
||||
sig { params(size: T.nilable(::Integer), statistics_resources: T.nilable(T::Array[::OpenApiSDK::Operations::StatisticsResources])).void }
|
||||
def initialize(size: nil, statistics_resources: nil)
|
||||
@size = size
|
||||
@statistics_resources = statistics_resources
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,26 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetResourcesStatisticsRequest < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The timespan to retrieve statistics for
|
||||
# the exact meaning of this parameter is not known
|
||||
#
|
||||
field :timespan, T.nilable(::Integer), { 'query_param': { 'field_name': 'Timespan', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(timespan: T.nilable(::Integer)).void }
|
||||
def initialize(timespan: nil)
|
||||
@timespan = timespan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,36 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetResourcesStatisticsResponse < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# HTTP response content type for this operation
|
||||
field :content_type, ::String
|
||||
# Raw HTTP response; suitable for custom response parsing
|
||||
field :raw_response, ::Faraday::Response
|
||||
# HTTP response status code for this operation
|
||||
field :status_code, ::Integer
|
||||
# Resource Statistics
|
||||
field :two_hundred_application_json_object, T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponseBody)
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
field :four_hundred_and_one_application_json_object, T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsStatisticsResponseBody)
|
||||
|
||||
|
||||
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, two_hundred_application_json_object: T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsResponseBody), four_hundred_and_one_application_json_object: T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsStatisticsResponseBody)).void }
|
||||
def initialize(content_type: nil, raw_response: nil, status_code: nil, two_hundred_application_json_object: nil, four_hundred_and_one_application_json_object: nil)
|
||||
@content_type = content_type
|
||||
@raw_response = raw_response
|
||||
@status_code = status_code
|
||||
@two_hundred_application_json_object = two_hundred_application_json_object
|
||||
@four_hundred_and_one_application_json_object = four_hundred_and_one_application_json_object
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
# Resource Statistics
|
||||
class GetResourcesStatisticsResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :media_container, T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsMediaContainer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('MediaContainer') } }
|
||||
|
||||
|
||||
sig { params(media_container: T.nilable(::OpenApiSDK::Operations::GetResourcesStatisticsMediaContainer)).void }
|
||||
def initialize(media_container: nil)
|
||||
@media_container = media_container
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
class GetResourcesStatisticsStatisticsResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :errors, T.nilable(T::Array[::OpenApiSDK::Operations::GetResourcesStatisticsErrors]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('errors') } }
|
||||
|
||||
|
||||
sig { params(errors: T.nilable(T::Array[::OpenApiSDK::Operations::GetResourcesStatisticsErrors])).void }
|
||||
def initialize(errors: nil)
|
||||
@errors = errors
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,38 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetSessionHistoryRequest < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# Filter results by those that are related to a specific users id
|
||||
#
|
||||
field :account_id, T.nilable(::Integer), { 'query_param': { 'field_name': 'accountId', 'style': 'form', 'explode': true } }
|
||||
# Filters content by field and direction/equality
|
||||
# (Unknown if viewedAt is the only supported column)
|
||||
#
|
||||
field :filter, T.nilable(::OpenApiSDK::Operations::Filter), { 'query_param': { 'field_name': 'filter', 'style': 'form', 'explode': true } }
|
||||
# Filters the results based on the id of a valid library section
|
||||
#
|
||||
field :library_section_id, T.nilable(::Integer), { 'query_param': { 'field_name': 'librarySectionID', 'style': 'form', 'explode': true } }
|
||||
# Sorts the results by the specified field followed by the direction (asc, desc)
|
||||
#
|
||||
field :sort, T.nilable(::String), { 'query_param': { 'field_name': 'sort', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(account_id: T.nilable(::Integer), filter: T.nilable(::OpenApiSDK::Operations::Filter), library_section_id: T.nilable(::Integer), sort: T.nilable(::String)).void }
|
||||
def initialize(account_id: nil, filter: nil, library_section_id: nil, sort: nil)
|
||||
@account_id = account_id
|
||||
@filter = filter
|
||||
@library_section_id = library_section_id
|
||||
@sort = sort
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -82,12 +82,12 @@ module OpenApiSDK
|
||||
|
||||
field :updated_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updatedAt') } }
|
||||
|
||||
field :user, T.nilable(::OpenApiSDK::Operations::User), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('User') } }
|
||||
field :user, T.nilable(::OpenApiSDK::Operations::GetSessionsUser), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('User') } }
|
||||
|
||||
field :view_offset, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('viewOffset') } }
|
||||
|
||||
|
||||
sig { params(added_at: T.nilable(::Integer), art: T.nilable(::String), duration: T.nilable(::Integer), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), guid: T.nilable(::String), index: T.nilable(::Integer), key: T.nilable(::String), library_section_id: T.nilable(::String), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), media: T.nilable(T::Array[::OpenApiSDK::Operations::GetSessionsMedia]), music_analysis_version: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_studio: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), player: T.nilable(::OpenApiSDK::Operations::Player), rating_count: T.nilable(::Integer), rating_key: T.nilable(::String), session: T.nilable(::OpenApiSDK::Operations::Session), session_key: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String), title_sort: T.nilable(::String), type: T.nilable(::String), updated_at: T.nilable(::Integer), user: T.nilable(::OpenApiSDK::Operations::User), view_offset: T.nilable(::Integer)).void }
|
||||
sig { params(added_at: T.nilable(::Integer), art: T.nilable(::String), duration: T.nilable(::Integer), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), guid: T.nilable(::String), index: T.nilable(::Integer), key: T.nilable(::String), library_section_id: T.nilable(::String), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), media: T.nilable(T::Array[::OpenApiSDK::Operations::GetSessionsMedia]), music_analysis_version: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_studio: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), parent_year: T.nilable(::Integer), player: T.nilable(::OpenApiSDK::Operations::Player), rating_count: T.nilable(::Integer), rating_key: T.nilable(::String), session: T.nilable(::OpenApiSDK::Operations::Session), session_key: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String), title_sort: T.nilable(::String), type: T.nilable(::String), updated_at: T.nilable(::Integer), user: T.nilable(::OpenApiSDK::Operations::GetSessionsUser), view_offset: T.nilable(::Integer)).void }
|
||||
def initialize(added_at: nil, art: nil, duration: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_thumb: nil, grandparent_title: nil, guid: nil, index: nil, key: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, media: nil, music_analysis_version: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_studio: nil, parent_thumb: nil, parent_title: nil, parent_year: nil, player: nil, rating_count: nil, rating_key: nil, session: nil, session_key: nil, thumb: nil, title: nil, title_sort: nil, type: nil, updated_at: nil, user: nil, view_offset: nil)
|
||||
@added_at = added_at
|
||||
@art = art
|
||||
|
||||
30
lib/open_api_sdk/models/operations/getsessions_user.rb
Normal file
30
lib/open_api_sdk/models/operations/getsessions_user.rb
Normal file
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetSessionsUser < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('thumb') } }
|
||||
|
||||
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
||||
|
||||
|
||||
sig { params(id: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String)).void }
|
||||
def initialize(id: nil, thumb: nil, title: nil)
|
||||
@id = id
|
||||
@thumb = thumb
|
||||
@title = title
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentCountry < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :filter, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('filter') } }
|
||||
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :tag, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tag') } }
|
||||
|
||||
|
||||
sig { params(filter: T.nilable(::String), id: T.nilable(::Integer), tag: T.nilable(::String)).void }
|
||||
def initialize(filter: nil, id: nil, tag: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@tag = tag
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentGenre < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :filter, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('filter') } }
|
||||
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :tag, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tag') } }
|
||||
|
||||
|
||||
sig { params(filter: T.nilable(::String), id: T.nilable(::Integer), tag: T.nilable(::String)).void }
|
||||
def initialize(filter: nil, id: nil, tag: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@tag = tag
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentGuids < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
|
||||
sig { params(id: T.nilable(::String)).void }
|
||||
def initialize(id: nil)
|
||||
@id = id
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentMediaContainer < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :allow_sync, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('allowSync') } }
|
||||
|
||||
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
||||
|
||||
field :media_tag_prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('mediaTagPrefix') } }
|
||||
|
||||
field :media_tag_version, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('mediaTagVersion') } }
|
||||
|
||||
field :metadata, T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentMetadata]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Metadata') } }
|
||||
|
||||
field :size, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('size') } }
|
||||
|
||||
|
||||
sig { params(allow_sync: T.nilable(T::Boolean), identifier: T.nilable(::String), media_tag_prefix: T.nilable(::String), media_tag_version: T.nilable(::Integer), metadata: T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentMetadata]), size: T.nilable(::Integer)).void }
|
||||
def initialize(allow_sync: nil, identifier: nil, media_tag_prefix: nil, media_tag_version: nil, metadata: nil, size: nil)
|
||||
@allow_sync = allow_sync
|
||||
@identifier = identifier
|
||||
@media_tag_prefix = media_tag_prefix
|
||||
@media_tag_version = media_tag_version
|
||||
@metadata = metadata
|
||||
@size = size
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,117 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentMetadata < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :added_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('addedAt') } }
|
||||
|
||||
field :art, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('art') } }
|
||||
|
||||
field :audience_rating, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('audienceRating') } }
|
||||
|
||||
field :audience_rating_image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('audienceRatingImage') } }
|
||||
|
||||
field :child_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('childCount') } }
|
||||
|
||||
field :content_rating, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('contentRating') } }
|
||||
|
||||
field :country, T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentCountry]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Country') } }
|
||||
|
||||
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('duration') } }
|
||||
|
||||
field :genre, T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentGenre]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Genre') } }
|
||||
|
||||
field :global_view_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('globalViewCount') } }
|
||||
|
||||
field :guid, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('guid') } }
|
||||
|
||||
field :guids, T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentGuids]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Guid') } }
|
||||
|
||||
field :index, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('index') } }
|
||||
|
||||
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
||||
|
||||
field :leaf_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leafCount') } }
|
||||
|
||||
field :library_section_id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionID') } }
|
||||
|
||||
field :library_section_key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionKey') } }
|
||||
|
||||
field :library_section_title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('librarySectionTitle') } }
|
||||
|
||||
field :originally_available_at, T.nilable(::Date), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('originallyAvailableAt'), 'decoder': Utils.date_from_iso_format(true) } }
|
||||
|
||||
field :rating_key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ratingKey') } }
|
||||
|
||||
field :role, T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentRole]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('Role') } }
|
||||
|
||||
field :slug, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } }
|
||||
|
||||
field :studio, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('studio') } }
|
||||
|
||||
field :summary, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('summary') } }
|
||||
|
||||
field :tagline, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagline') } }
|
||||
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('thumb') } }
|
||||
|
||||
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
||||
|
||||
field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('type') } }
|
||||
|
||||
field :updated_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updatedAt') } }
|
||||
|
||||
field :user, T.nilable(T::Array[::OpenApiSDK::Operations::User]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('User') } }
|
||||
|
||||
field :viewed_leaf_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('viewedLeafCount') } }
|
||||
|
||||
field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('year') } }
|
||||
|
||||
|
||||
sig { params(added_at: T.nilable(::Integer), art: T.nilable(::String), audience_rating: T.nilable(::Float), audience_rating_image: T.nilable(::String), child_count: T.nilable(::Integer), content_rating: T.nilable(::String), country: T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentCountry]), duration: T.nilable(::Integer), genre: T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentGenre]), global_view_count: T.nilable(::Integer), guid: T.nilable(::String), guids: T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentGuids]), index: T.nilable(::Integer), key: T.nilable(::String), leaf_count: T.nilable(::Integer), library_section_id: T.nilable(::Integer), library_section_key: T.nilable(::String), library_section_title: T.nilable(::String), originally_available_at: T.nilable(::Date), rating_key: T.nilable(::String), role: T.nilable(T::Array[::OpenApiSDK::Operations::GetTopWatchedContentRole]), slug: T.nilable(::String), studio: T.nilable(::String), summary: T.nilable(::String), tagline: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String), type: T.nilable(::String), updated_at: T.nilable(::Integer), user: T.nilable(T::Array[::OpenApiSDK::Operations::User]), viewed_leaf_count: T.nilable(::Integer), year: T.nilable(::Integer)).void }
|
||||
def initialize(added_at: nil, art: nil, audience_rating: nil, audience_rating_image: nil, child_count: nil, content_rating: nil, country: nil, duration: nil, genre: nil, global_view_count: nil, guid: nil, guids: nil, index: nil, key: nil, leaf_count: nil, library_section_id: nil, library_section_key: nil, library_section_title: nil, originally_available_at: nil, rating_key: nil, role: nil, slug: nil, studio: nil, summary: nil, tagline: nil, thumb: nil, title: nil, type: nil, updated_at: nil, user: nil, viewed_leaf_count: nil, year: nil)
|
||||
@added_at = added_at
|
||||
@art = art
|
||||
@audience_rating = audience_rating
|
||||
@audience_rating_image = audience_rating_image
|
||||
@child_count = child_count
|
||||
@content_rating = content_rating
|
||||
@country = country
|
||||
@duration = duration
|
||||
@genre = genre
|
||||
@global_view_count = global_view_count
|
||||
@guid = guid
|
||||
@guids = guids
|
||||
@index = index
|
||||
@key = key
|
||||
@leaf_count = leaf_count
|
||||
@library_section_id = library_section_id
|
||||
@library_section_key = library_section_key
|
||||
@library_section_title = library_section_title
|
||||
@originally_available_at = originally_available_at
|
||||
@rating_key = rating_key
|
||||
@role = role
|
||||
@slug = slug
|
||||
@studio = studio
|
||||
@summary = summary
|
||||
@tagline = tagline
|
||||
@thumb = thumb
|
||||
@title = title
|
||||
@type = type
|
||||
@updated_at = updated_at
|
||||
@user = user
|
||||
@viewed_leaf_count = viewed_leaf_count
|
||||
@year = year
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,28 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentRequest < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# the library type (1 - movies, 2 - shows, 3 - music)
|
||||
field :type, ::Integer, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
# Adds the Guids object to the response
|
||||
#
|
||||
field :include_guids, T.nilable(::Integer), { 'query_param': { 'field_name': 'includeGuids', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(type: ::Integer, include_guids: T.nilable(::Integer)).void }
|
||||
def initialize(type: nil, include_guids: nil)
|
||||
@type = type
|
||||
@include_guids = include_guids
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,33 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentResponse < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# HTTP response content type for this operation
|
||||
field :content_type, ::String
|
||||
# Raw HTTP response; suitable for custom response parsing
|
||||
field :raw_response, ::Faraday::Response
|
||||
# HTTP response status code for this operation
|
||||
field :status_code, ::Integer
|
||||
# The metadata of the library item.
|
||||
field :object, T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponseBody)
|
||||
|
||||
|
||||
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, object: T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentResponseBody)).void }
|
||||
def initialize(content_type: nil, raw_response: nil, status_code: nil, object: nil)
|
||||
@content_type = content_type
|
||||
@raw_response = raw_response
|
||||
@status_code = status_code
|
||||
@object = object
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
# The metadata of the library item.
|
||||
class GetTopWatchedContentResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :media_container, T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentMediaContainer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('MediaContainer') } }
|
||||
|
||||
|
||||
sig { params(media_container: T.nilable(::OpenApiSDK::Operations::GetTopWatchedContentMediaContainer)).void }
|
||||
def initialize(media_container: nil)
|
||||
@media_container = media_container
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetTopWatchedContentRole < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :filter, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('filter') } }
|
||||
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :role, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('role') } }
|
||||
|
||||
field :tag, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tag') } }
|
||||
|
||||
field :tag_key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagKey') } }
|
||||
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('thumb') } }
|
||||
|
||||
|
||||
sig { params(filter: T.nilable(::String), id: T.nilable(::Integer), role: T.nilable(::String), tag: T.nilable(::String), tag_key: T.nilable(::String), thumb: T.nilable(::String)).void }
|
||||
def initialize(filter: nil, id: nil, role: nil, tag: nil, tag_key: nil, thumb: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@role = role
|
||||
@tag = tag
|
||||
@tag_key = tag_key
|
||||
@thumb = thumb
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -15,7 +15,7 @@ module OpenApiSDK
|
||||
extend T::Sig
|
||||
|
||||
# Filter
|
||||
field :filter, ::OpenApiSDK::Operations::Filter, { 'path_param': { 'field_name': 'filter', 'style': 'simple', 'explode': false } }
|
||||
field :filter, ::OpenApiSDK::Operations::PathParamFilter, { 'path_param': { 'field_name': 'filter', 'style': 'simple', 'explode': false } }
|
||||
# User Token
|
||||
field :x_plex_token, ::String, { 'query_param': { 'field_name': 'X-Plex-Token', 'style': 'form', 'explode': true } }
|
||||
# include collections in the results
|
||||
@@ -46,7 +46,7 @@ module OpenApiSDK
|
||||
field :x_plex_container_start, T.nilable(::Integer), { 'query_param': { 'field_name': 'X-Plex-Container-Start', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(filter: ::OpenApiSDK::Operations::Filter, x_plex_token: ::String, include_collections: T.nilable(::OpenApiSDK::Operations::IncludeCollections), include_external_media: T.nilable(::OpenApiSDK::Operations::IncludeExternalMedia), libtype: T.nilable(::OpenApiSDK::Operations::Libtype), maxresults: T.nilable(::Integer), sort: T.nilable(::String), x_plex_container_size: T.nilable(::Integer), x_plex_container_start: T.nilable(::Integer)).void }
|
||||
sig { params(filter: ::OpenApiSDK::Operations::PathParamFilter, x_plex_token: ::String, include_collections: T.nilable(::OpenApiSDK::Operations::IncludeCollections), include_external_media: T.nilable(::OpenApiSDK::Operations::IncludeExternalMedia), libtype: T.nilable(::OpenApiSDK::Operations::Libtype), maxresults: T.nilable(::Integer), sort: T.nilable(::String), x_plex_container_size: T.nilable(::Integer), x_plex_container_start: T.nilable(::Integer)).void }
|
||||
def initialize(filter: nil, x_plex_token: nil, include_collections: nil, include_external_media: nil, libtype: nil, maxresults: nil, sort: nil, x_plex_container_size: nil, x_plex_container_start: nil)
|
||||
@filter = filter
|
||||
@x_plex_token = x_plex_token
|
||||
|
||||
23
lib/open_api_sdk/models/operations/pathparam_filter.rb
Normal file
23
lib/open_api_sdk/models/operations/pathparam_filter.rb
Normal file
@@ -0,0 +1,23 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
PATH_PARAM_FILTER_SERVERS = [
|
||||
'https://metadata.provider.plex.tv'
|
||||
].freeze
|
||||
|
||||
# PathParamFilter - Filter
|
||||
class PathParamFilter < T::Enum
|
||||
enums do
|
||||
ALL = new('all')
|
||||
AVAILABLE = new('available')
|
||||
RELEASED = new('released')
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
39
lib/open_api_sdk/models/operations/statisticsbandwidth.rb
Normal file
39
lib/open_api_sdk/models/operations/statisticsbandwidth.rb
Normal file
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class StatisticsBandwidth < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :account_id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('accountID') } }
|
||||
|
||||
field :at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('at') } }
|
||||
|
||||
field :bytes, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('bytes') } }
|
||||
|
||||
field :device_id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('deviceID') } }
|
||||
|
||||
field :lan, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lan') } }
|
||||
|
||||
field :timespan, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('timespan') } }
|
||||
|
||||
|
||||
sig { params(account_id: T.nilable(::Integer), at: T.nilable(::Integer), bytes: T.nilable(::Integer), device_id: T.nilable(::Integer), lan: T.nilable(T::Boolean), timespan: T.nilable(::Integer)).void }
|
||||
def initialize(account_id: nil, at: nil, bytes: nil, device_id: nil, lan: nil, timespan: nil)
|
||||
@account_id = account_id
|
||||
@at = at
|
||||
@bytes = bytes
|
||||
@device_id = device_id
|
||||
@lan = lan
|
||||
@timespan = timespan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
39
lib/open_api_sdk/models/operations/statisticsresources.rb
Normal file
39
lib/open_api_sdk/models/operations/statisticsresources.rb
Normal file
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module OpenApiSDK
|
||||
module Operations
|
||||
|
||||
|
||||
class StatisticsResources < ::OpenApiSDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('at') } }
|
||||
|
||||
field :host_cpu_utilization, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('hostCpuUtilization') } }
|
||||
|
||||
field :host_memory_utilization, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('hostMemoryUtilization') } }
|
||||
|
||||
field :process_cpu_utilization, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('processCpuUtilization') } }
|
||||
|
||||
field :process_memory_utilization, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('processMemoryUtilization') } }
|
||||
|
||||
field :timespan, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('timespan') } }
|
||||
|
||||
|
||||
sig { params(at: T.nilable(::Integer), host_cpu_utilization: T.nilable(::Float), host_memory_utilization: T.nilable(::Float), process_cpu_utilization: T.nilable(::Float), process_memory_utilization: T.nilable(::Float), timespan: T.nilable(::Integer)).void }
|
||||
def initialize(at: nil, host_cpu_utilization: nil, host_memory_utilization: nil, process_cpu_utilization: nil, process_memory_utilization: nil, timespan: nil)
|
||||
@at = at
|
||||
@host_cpu_utilization = host_cpu_utilization
|
||||
@host_memory_utilization = host_memory_utilization
|
||||
@process_cpu_utilization = process_cpu_utilization
|
||||
@process_memory_utilization = process_memory_utilization
|
||||
@timespan = timespan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -12,18 +12,12 @@ module OpenApiSDK
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('thumb') } }
|
||||
|
||||
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
||||
field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
||||
|
||||
|
||||
sig { params(id: T.nilable(::String), thumb: T.nilable(::String), title: T.nilable(::String)).void }
|
||||
def initialize(id: nil, thumb: nil, title: nil)
|
||||
sig { params(id: T.nilable(::Integer)).void }
|
||||
def initialize(id: nil)
|
||||
@id = id
|
||||
@thumb = thumb
|
||||
@title = title
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -190,7 +190,7 @@ module OpenApiSDK
|
||||
res = ::OpenApiSDK::Operations::DeletePlaylistResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if [200, 400].include?(r.status)
|
||||
if [204, 400].include?(r.status)
|
||||
elsif r.status == 401
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::DeletePlaylistResponseBody)
|
||||
|
||||
@@ -42,9 +42,9 @@ module OpenApiSDK
|
||||
@globals = globals.nil? ? {} : globals
|
||||
@language = 'ruby'
|
||||
@openapi_doc_version = '0.0.3'
|
||||
@sdk_version = '0.2.0'
|
||||
@gen_version = '2.342.6'
|
||||
@user_agent = 'speakeasy-sdk/ruby 0.2.0 2.342.6 0.0.3 plexruby'
|
||||
@sdk_version = '0.2.1'
|
||||
@gen_version = '2.349.6'
|
||||
@user_agent = 'speakeasy-sdk/ruby 0.2.1 2.349.6 0.0.3 plexruby'
|
||||
end
|
||||
|
||||
sig { returns([String, T::Hash[Symbol, String]]) }
|
||||
|
||||
@@ -22,8 +22,8 @@ module OpenApiSDK
|
||||
|
||||
sig { returns(::OpenApiSDK::Operations::GetServerCapabilitiesResponse) }
|
||||
def get_server_capabilities
|
||||
# get_server_capabilities - Server Capabilities
|
||||
# Server Capabilities
|
||||
# get_server_capabilities - Get Server Capabilities
|
||||
# Get Server Capabilities
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = "#{base_url}/"
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
module OpenApiSDK
|
||||
module ServerVariables
|
||||
|
||||
# ServerProtocol - The protocol to use when connecting to your plex server.
|
||||
|
||||
class ServerProtocol < T::Enum
|
||||
enums do
|
||||
HTTP = new('http')
|
||||
|
||||
@@ -57,19 +57,28 @@ module OpenApiSDK
|
||||
end
|
||||
|
||||
|
||||
sig { returns(::OpenApiSDK::Operations::GetSessionHistoryResponse) }
|
||||
def get_session_history
|
||||
sig { params(sort: T.nilable(::String), account_id: T.nilable(::Integer), filter: T.nilable(::OpenApiSDK::Operations::Filter), library_section_id: T.nilable(::Integer)).returns(::OpenApiSDK::Operations::GetSessionHistoryResponse) }
|
||||
def get_session_history(sort = nil, account_id = nil, filter = nil, library_section_id = nil)
|
||||
# get_session_history - Get Session History
|
||||
# This will Retrieve a listing of all history views.
|
||||
request = ::OpenApiSDK::Operations::GetSessionHistoryRequest.new(
|
||||
|
||||
sort: sort,
|
||||
account_id: account_id,
|
||||
filter: filter,
|
||||
library_section_id: library_section_id
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = "#{base_url}/status/sessions/history/all"
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetSessionHistoryRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
|
||||
@@ -61,5 +61,91 @@ module OpenApiSDK
|
||||
end
|
||||
res
|
||||
end
|
||||
|
||||
|
||||
sig { params(timespan: T.nilable(::Integer)).returns(::OpenApiSDK::Operations::GetResourcesStatisticsResponse) }
|
||||
def get_resources_statistics(timespan = nil)
|
||||
# get_resources_statistics - Get Resources Statistics
|
||||
# This will return the resources for the server
|
||||
request = ::OpenApiSDK::Operations::GetResourcesStatisticsRequest.new(
|
||||
|
||||
timespan: timespan
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = "#{base_url}/statistics/resources"
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetResourcesStatisticsRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
||||
|
||||
res = ::OpenApiSDK::Operations::GetResourcesStatisticsResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if r.status == 200
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetResourcesStatisticsResponseBody)
|
||||
res.two_hundred_application_json_object = out
|
||||
end
|
||||
elsif r.status == 400
|
||||
elsif r.status == 401
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetResourcesStatisticsStatisticsResponseBody)
|
||||
res.four_hundred_and_one_application_json_object = out
|
||||
end
|
||||
end
|
||||
res
|
||||
end
|
||||
|
||||
|
||||
sig { params(timespan: T.nilable(::Integer)).returns(::OpenApiSDK::Operations::GetBandwidthStatisticsResponse) }
|
||||
def get_bandwidth_statistics(timespan = nil)
|
||||
# get_bandwidth_statistics - Get Bandwidth Statistics
|
||||
# This will return the bandwidth statistics for the server
|
||||
request = ::OpenApiSDK::Operations::GetBandwidthStatisticsRequest.new(
|
||||
|
||||
timespan: timespan
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = "#{base_url}/statistics/bandwidth"
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetBandwidthStatisticsRequest, request, @sdk_configuration.globals)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
||||
|
||||
res = ::OpenApiSDK::Operations::GetBandwidthStatisticsResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if r.status == 200
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetBandwidthStatisticsResponseBody)
|
||||
res.two_hundred_application_json_object = out
|
||||
end
|
||||
elsif r.status == 400
|
||||
elsif r.status == 401
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetBandwidthStatisticsStatisticsResponseBody)
|
||||
res.four_hundred_and_one_application_json_object = out
|
||||
end
|
||||
end
|
||||
res
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
|
||||
|
||||
Gem::Specification.new do |s|
|
||||
s.name = 'plexruby'
|
||||
s.version = '0.2.0'
|
||||
s.version = '0.2.1'
|
||||
s.platform = Gem::Platform::RUBY
|
||||
s.licenses = ['Apache-2.0']
|
||||
s.summary = ''
|
||||
|
||||
Reference in New Issue
Block a user