mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
regenerated with newest spec, reconfigured actions and adding publishing
This commit is contained in:
Luke Hagar
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
name: Generate
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
"on":
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
force:
|
||||||
|
description: Force generation of SDKs
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
set_version:
|
||||||
|
description: optionally set a specific SDK version
|
||||||
|
type: string
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
|
jobs:
|
||||||
|
generate:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
|
with:
|
||||||
|
force: ${{ github.event.inputs.force }}
|
||||||
|
mode: pr
|
||||||
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
|
speakeasy_version: latest
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
rubygems_auth_token: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
20
.github/workflows/sdk_publish.yaml
vendored
Normal file
20
.github/workflows/sdk_publish.yaml
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
name: Publish
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
"on":
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- RELEASES.md
|
||||||
|
- '*/RELEASES.md'
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
rubygems_auth_token: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
30
.github/workflows/speakeasy_sdk_generation.yml
vendored
30
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -1,30 +0,0 @@
|
|||||||
name: Generate
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
"on":
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
force:
|
|
||||||
description: Force generation of SDKs
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
push_code_samples_only:
|
|
||||||
description: Force push only code samples from SDK generation
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
schedule:
|
|
||||||
- cron: 0 0 * * *
|
|
||||||
jobs:
|
|
||||||
generate:
|
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
|
||||||
with:
|
|
||||||
force: ${{ github.event.inputs.force }}
|
|
||||||
mode: direct
|
|
||||||
push_code_samples_only: ${{ fromJSON(github.event.inputs.push_code_samples_only) }}
|
|
||||||
speakeasy_version: latest
|
|
||||||
secrets:
|
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
|
||||||
20
.github/workflows/tagging.yaml
vendored
20
.github/workflows/tagging.yaml
vendored
@@ -1,20 +0,0 @@
|
|||||||
name: Speakeasy Tagging
|
|
||||||
permissions:
|
|
||||||
checks: write
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
statuses: write
|
|
||||||
"on":
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths: []
|
|
||||||
workflow_dispatch: {}
|
|
||||||
jobs:
|
|
||||||
tag:
|
|
||||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/tag.yaml@v15
|
|
||||||
with:
|
|
||||||
registry_tags: main
|
|
||||||
secrets:
|
|
||||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
|
||||||
3298
.speakeasy/gen.lock
3298
.speakeasy/gen.lock
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: false
|
oAuth2ClientCredentialsEnabled: false
|
||||||
ruby:
|
ruby:
|
||||||
version: 0.2.2
|
version: 0.3.1
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
description: Ruby Client SDK Generated by Speakeasy
|
description: Ruby Client SDK Generated by Speakeasy
|
||||||
imports:
|
imports:
|
||||||
@@ -25,6 +25,6 @@ ruby:
|
|||||||
webhooks: models/webhooks
|
webhooks: models/webhooks
|
||||||
inputModelSuffix: input
|
inputModelSuffix: input
|
||||||
maxMethodParams: 4
|
maxMethodParams: 4
|
||||||
module: OpenApiSdk
|
module: PlexRubySDK
|
||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: plexruby
|
packageName: plexruby
|
||||||
|
|||||||
@@ -1,30 +1,26 @@
|
|||||||
speakeasyVersion: 1.323.0
|
speakeasyVersion: 1.397.0
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:721539660c22a7f2ba3b0ed8d71c2ce29bfa19693a5c04678c22dbd586a5f035
|
sourceRevisionDigest: sha256:90da815184f89206abe4694aca05802c71d19c10d572a0a1f84d89883e5fce45
|
||||||
sourceBlobDigest: sha256:943fb1e9bd8048efbda87a1af9ebec6d822c22f871d18bad37434f1de29ab5a7
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
|
||||||
targets:
|
targets:
|
||||||
plexruby:
|
plexruby:
|
||||||
source: my-source
|
source: my-source
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
sourceRevisionDigest: sha256:721539660c22a7f2ba3b0ed8d71c2ce29bfa19693a5c04678c22dbd586a5f035
|
sourceRevisionDigest: sha256:90da815184f89206abe4694aca05802c71d19c10d572a0a1f84d89883e5fce45
|
||||||
sourceBlobDigest: sha256:943fb1e9bd8048efbda87a1af9ebec6d822c22f871d18bad37434f1de29ab5a7
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
codeSamplesNamespace: code-samples-ruby-plexruby
|
codeSamplesNamespace: code-samples-ruby-plexruby
|
||||||
codeSamplesRevisionDigest: sha256:24ab3fdcfdf227479438768e2bcef3b25c3121818b5fe93478b3cb538b5ca0e5
|
codeSamplesRevisionDigest: sha256:c243b38c08c2a8e132455209e4581bce4a0fb3847580bb7ab9674973d6a9d5c9
|
||||||
outLocation: /github/workspace/repo
|
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||||
registry:
|
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
|
||||||
targets:
|
targets:
|
||||||
plexruby:
|
plexruby:
|
||||||
target: ruby
|
target: ruby
|
||||||
|
|||||||
@@ -3,13 +3,14 @@ speakeasyVersion: latest
|
|||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||||
registry:
|
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
|
||||||
targets:
|
targets:
|
||||||
plexruby:
|
plexruby:
|
||||||
target: ruby
|
target: ruby
|
||||||
source: my-source
|
source: my-source
|
||||||
|
publish:
|
||||||
|
rubygems:
|
||||||
|
token: $rubygems_auth_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
|
|||||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing to This Repository
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||||
|
|
||||||
|
## How to Report Issues
|
||||||
|
|
||||||
|
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||||
|
|
||||||
|
- A clear and descriptive title
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected and actual behavior
|
||||||
|
- Any relevant logs, screenshots, or error messages
|
||||||
|
- Information about your environment (e.g., operating system, software versions)
|
||||||
|
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||||
|
|
||||||
|
## Issue Triage and Upstream Fixes
|
||||||
|
|
||||||
|
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||||
|
|
||||||
|
Thank you for your understanding and cooperation!
|
||||||
|
|
||||||
|
The Maintainers
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
plexruby (0.2.2)
|
plexruby (0.3.1)
|
||||||
faraday
|
faraday
|
||||||
faraday-multipart
|
faraday-multipart
|
||||||
rack
|
rack
|
||||||
|
|||||||
165
README.md
165
README.md
@@ -7,9 +7,27 @@
|
|||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- Start Summary [summary] -->
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
|
<!-- Start Table of Contents [toc] -->
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
* [SDK Installation](#sdk-installation)
|
||||||
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
|
* [Global Parameters](#global-parameters)
|
||||||
|
* [Server Selection](#server-selection)
|
||||||
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
<!-- Start SDK Installation [installation] -->
|
<!-- Start SDK Installation [installation] -->
|
||||||
## SDK Installation
|
## SDK Installation
|
||||||
|
|
||||||
|
The SDK can be installed using [RubyGems](https://rubygems.org/):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gem install specific_install
|
gem install specific_install
|
||||||
gem specific_install https://github.com/LukeHagar/plexruby
|
gem specific_install https://github.com/LukeHagar/plexruby
|
||||||
@@ -25,11 +43,11 @@ gem specific_install https://github.com/LukeHagar/plexruby
|
|||||||
require 'plexruby'
|
require 'plexruby'
|
||||||
|
|
||||||
|
|
||||||
s = ::OpenApiSDK::PlexAPI.new(
|
s = ::PlexRubySDK::PlexAPI.new(
|
||||||
x_plex_client_identifier: "Postman",
|
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||||
)
|
)
|
||||||
s.config_security(
|
s.config_security(
|
||||||
::OpenApiSDK::Shared::Security.new(
|
::PlexRubySDK::Shared::Security.new(
|
||||||
access_token: "<YOUR_API_KEY_HERE>",
|
access_token: "<YOUR_API_KEY_HERE>",
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
@@ -37,7 +55,7 @@ s.config_security(
|
|||||||
|
|
||||||
res = s.server.get_server_capabilities()
|
res = s.server.get_server_capabilities()
|
||||||
|
|
||||||
if ! res.two_hundred_application_json_object.nil?
|
if ! res.object.nil?
|
||||||
# handle response
|
# handle response
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -47,33 +65,21 @@ end
|
|||||||
<!-- Start Available Resources and Operations [operations] -->
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
## Available Resources and Operations
|
## Available Resources and Operations
|
||||||
|
|
||||||
### [Server](docs/sdks/server/README.md)
|
<details open>
|
||||||
|
<summary>Available methods</summary>
|
||||||
* [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
|
|
||||||
* [get_server_identity](docs/sdks/server/README.md#get_server_identity) - Get Server Identity
|
|
||||||
* [get_my_plex_account](docs/sdks/server/README.md#get_my_plex_account) - Get MyPlex Account
|
|
||||||
* [get_resized_photo](docs/sdks/server/README.md#get_resized_photo) - Get a Resized Photo
|
|
||||||
* [get_server_list](docs/sdks/server/README.md#get_server_list) - Get Server List
|
|
||||||
|
|
||||||
### [Media](docs/sdks/media/README.md)
|
|
||||||
|
|
||||||
* [mark_played](docs/sdks/media/README.md#mark_played) - Mark Media Played
|
|
||||||
* [mark_unplayed](docs/sdks/media/README.md#mark_unplayed) - Mark Media Unplayed
|
|
||||||
* [update_play_progress](docs/sdks/media/README.md#update_play_progress) - Update Media Play Progress
|
|
||||||
|
|
||||||
### [Video](docs/sdks/video/README.md)
|
|
||||||
|
|
||||||
* [get_timeline](docs/sdks/video/README.md#get_timeline) - Get the timeline for a media item
|
|
||||||
* [start_universal_transcode](docs/sdks/video/README.md#start_universal_transcode) - Start Universal Transcode
|
|
||||||
|
|
||||||
### [Activities](docs/sdks/activities/README.md)
|
### [Activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
* [get_server_activities](docs/sdks/activities/README.md#get_server_activities) - Get Server Activities
|
* [get_server_activities](docs/sdks/activities/README.md#get_server_activities) - Get Server Activities
|
||||||
* [cancel_server_activities](docs/sdks/activities/README.md#cancel_server_activities) - Cancel Server Activities
|
* [cancel_server_activities](docs/sdks/activities/README.md#cancel_server_activities) - Cancel Server Activities
|
||||||
|
|
||||||
|
### [Authentication](docs/sdks/authentication/README.md)
|
||||||
|
|
||||||
|
* [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token
|
||||||
|
* [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
|
||||||
|
* [get_token_details](docs/sdks/authentication/README.md#get_token_details) - Get Token Details
|
||||||
|
* [post_users_sign_in_data](docs/sdks/authentication/README.md#post_users_sign_in_data) - Get User Sign In Data
|
||||||
|
|
||||||
### [Butler](docs/sdks/butler/README.md)
|
### [Butler](docs/sdks/butler/README.md)
|
||||||
|
|
||||||
* [get_butler_tasks](docs/sdks/butler/README.md#get_butler_tasks) - Get Butler tasks
|
* [get_butler_tasks](docs/sdks/butler/README.md#get_butler_tasks) - Get Butler tasks
|
||||||
@@ -82,34 +88,22 @@ end
|
|||||||
* [start_task](docs/sdks/butler/README.md#start_task) - Start a single Butler task
|
* [start_task](docs/sdks/butler/README.md#start_task) - Start a single Butler task
|
||||||
* [stop_task](docs/sdks/butler/README.md#stop_task) - Stop a single Butler task
|
* [stop_task](docs/sdks/butler/README.md#stop_task) - Stop a single Butler task
|
||||||
|
|
||||||
### [Plex](docs/sdks/plex/README.md)
|
|
||||||
|
|
||||||
* [get_home_data](docs/sdks/plex/README.md#get_home_data) - Get Plex Home Data
|
|
||||||
* [get_pin](docs/sdks/plex/README.md#get_pin) - Get a Pin
|
|
||||||
* [get_token](docs/sdks/plex/README.md#get_token) - Get Access Token
|
|
||||||
|
|
||||||
### [Hubs](docs/sdks/hubs/README.md)
|
### [Hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [get_global_hubs](docs/sdks/hubs/README.md#get_global_hubs) - Get Global Hubs
|
* [get_global_hubs](docs/sdks/hubs/README.md#get_global_hubs) - Get Global Hubs
|
||||||
* [get_library_hubs](docs/sdks/hubs/README.md#get_library_hubs) - Get library specific hubs
|
* [get_library_hubs](docs/sdks/hubs/README.md#get_library_hubs) - Get library specific hubs
|
||||||
|
|
||||||
### [Search](docs/sdks/search/README.md)
|
|
||||||
|
|
||||||
* [perform_search](docs/sdks/search/README.md#perform_search) - Perform a search
|
|
||||||
* [perform_voice_search](docs/sdks/search/README.md#perform_voice_search) - Perform a voice search
|
|
||||||
* [get_search_results](docs/sdks/search/README.md#get_search_results) - Get Search Results
|
|
||||||
|
|
||||||
### [Library](docs/sdks/library/README.md)
|
### [Library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [get_file_hash](docs/sdks/library/README.md#get_file_hash) - Get Hash Value
|
* [get_file_hash](docs/sdks/library/README.md#get_file_hash) - Get Hash Value
|
||||||
* [get_recently_added](docs/sdks/library/README.md#get_recently_added) - Get Recently Added
|
* [get_recently_added](docs/sdks/library/README.md#get_recently_added) - Get Recently Added
|
||||||
* [get_libraries](docs/sdks/library/README.md#get_libraries) - Get All Libraries
|
* [get_all_libraries](docs/sdks/library/README.md#get_all_libraries) - Get All Libraries
|
||||||
* [get_library](docs/sdks/library/README.md#get_library) - Get Library Details
|
* [get_library_details](docs/sdks/library/README.md#get_library_details) - Get Library Details
|
||||||
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
|
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
|
||||||
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
|
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
|
||||||
* [refresh_library](docs/sdks/library/README.md#refresh_library) - Refresh Library
|
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
|
||||||
* [search_library](docs/sdks/library/README.md#search_library) - Search Library
|
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
|
||||||
* [get_metadata](docs/sdks/library/README.md#get_metadata) - Get Items Metadata
|
* [get_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||||
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
* [get_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_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
|
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||||
@@ -120,6 +114,14 @@ end
|
|||||||
* [log_multi_line](docs/sdks/log/README.md#log_multi_line) - Logging a multi-line message
|
* [log_multi_line](docs/sdks/log/README.md#log_multi_line) - Logging a multi-line message
|
||||||
* [enable_paper_trail](docs/sdks/log/README.md#enable_paper_trail) - Enabling Papertrail
|
* [enable_paper_trail](docs/sdks/log/README.md#enable_paper_trail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [Media](docs/sdks/media/README.md)
|
||||||
|
|
||||||
|
* [mark_played](docs/sdks/media/README.md#mark_played) - Mark Media Played
|
||||||
|
* [mark_unplayed](docs/sdks/media/README.md#mark_unplayed) - Mark Media Unplayed
|
||||||
|
* [update_play_progress](docs/sdks/media/README.md#update_play_progress) - Update Media Play Progress
|
||||||
|
* [get_banner_image](docs/sdks/media/README.md#get_banner_image) - Get Banner Image
|
||||||
|
* [get_thumb_image](docs/sdks/media/README.md#get_thumb_image) - Get Thumb Image
|
||||||
|
|
||||||
### [Playlists](docs/sdks/playlists/README.md)
|
### [Playlists](docs/sdks/playlists/README.md)
|
||||||
|
|
||||||
* [create_playlist](docs/sdks/playlists/README.md#create_playlist) - Create a Playlist
|
* [create_playlist](docs/sdks/playlists/README.md#create_playlist) - Create a Playlist
|
||||||
@@ -132,16 +134,34 @@ end
|
|||||||
* [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
|
* [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
|
||||||
* [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
|
* [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
|
||||||
|
|
||||||
### [Authentication](docs/sdks/authentication/README.md)
|
### [Plex](docs/sdks/plex/README.md)
|
||||||
|
|
||||||
* [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token.
|
* [get_companions_data](docs/sdks/plex/README.md#get_companions_data) - Get Companions Data
|
||||||
* [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
|
* [get_user_friends](docs/sdks/plex/README.md#get_user_friends) - Get list of friends of the user logged in
|
||||||
|
* [get_geo_data](docs/sdks/plex/README.md#get_geo_data) - Get Geo Data
|
||||||
|
* [get_home_data](docs/sdks/plex/README.md#get_home_data) - Get Plex Home Data
|
||||||
|
* [get_server_resources](docs/sdks/plex/README.md#get_server_resources) - Get Server Resources
|
||||||
|
* [get_pin](docs/sdks/plex/README.md#get_pin) - Get a Pin
|
||||||
|
* [get_token_by_pin_id](docs/sdks/plex/README.md#get_token_by_pin_id) - Get Access Token by PinId
|
||||||
|
|
||||||
### [Statistics](docs/sdks/statistics/README.md)
|
|
||||||
|
|
||||||
* [get_statistics](docs/sdks/statistics/README.md#get_statistics) - Get Media Statistics
|
### [Search](docs/sdks/search/README.md)
|
||||||
* [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
|
* [perform_search](docs/sdks/search/README.md#perform_search) - Perform a search
|
||||||
|
* [perform_voice_search](docs/sdks/search/README.md#perform_voice_search) - Perform a voice search
|
||||||
|
* [get_search_results](docs/sdks/search/README.md#get_search_results) - Get Search Results
|
||||||
|
|
||||||
|
### [Server](docs/sdks/server/README.md)
|
||||||
|
|
||||||
|
* [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
|
||||||
|
* [get_server_identity](docs/sdks/server/README.md#get_server_identity) - Get Server Identity
|
||||||
|
* [get_my_plex_account](docs/sdks/server/README.md#get_my_plex_account) - Get MyPlex Account
|
||||||
|
* [get_resized_photo](docs/sdks/server/README.md#get_resized_photo) - Get a Resized Photo
|
||||||
|
* [get_media_providers](docs/sdks/server/README.md#get_media_providers) - Get Media Providers
|
||||||
|
* [get_server_list](docs/sdks/server/README.md#get_server_list) - Get Server List
|
||||||
|
|
||||||
### [Sessions](docs/sdks/sessions/README.md)
|
### [Sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
@@ -150,15 +170,28 @@ end
|
|||||||
* [get_transcode_sessions](docs/sdks/sessions/README.md#get_transcode_sessions) - Get Transcode Sessions
|
* [get_transcode_sessions](docs/sdks/sessions/README.md#get_transcode_sessions) - Get Transcode Sessions
|
||||||
* [stop_transcode_session](docs/sdks/sessions/README.md#stop_transcode_session) - Stop a Transcode Session
|
* [stop_transcode_session](docs/sdks/sessions/README.md#stop_transcode_session) - Stop a Transcode Session
|
||||||
|
|
||||||
|
### [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
|
||||||
|
|
||||||
### [Updater](docs/sdks/updater/README.md)
|
### [Updater](docs/sdks/updater/README.md)
|
||||||
|
|
||||||
* [get_update_status](docs/sdks/updater/README.md#get_update_status) - Querying status of updates
|
* [get_update_status](docs/sdks/updater/README.md#get_update_status) - Querying status of updates
|
||||||
* [check_for_updates](docs/sdks/updater/README.md#check_for_updates) - Checking for updates
|
* [check_for_updates](docs/sdks/updater/README.md#check_for_updates) - Checking for updates
|
||||||
* [apply_updates](docs/sdks/updater/README.md#apply_updates) - Apply Updates
|
* [apply_updates](docs/sdks/updater/README.md#apply_updates) - Apply Updates
|
||||||
|
|
||||||
|
### [Video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [get_timeline](docs/sdks/video/README.md#get_timeline) - Get the timeline for a media item
|
||||||
|
* [start_universal_transcode](docs/sdks/video/README.md#start_universal_transcode) - Start Universal Transcode
|
||||||
|
|
||||||
### [Watchlist](docs/sdks/watchlist/README.md)
|
### [Watchlist](docs/sdks/watchlist/README.md)
|
||||||
|
|
||||||
* [get_watchlist](docs/sdks/watchlist/README.md#get_watchlist) - Get User Watchlist
|
* [get_watch_list](docs/sdks/watchlist/README.md#get_watch_list) - Get User Watchlist
|
||||||
|
|
||||||
|
</details>
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
<!-- Start Server Selection [server] -->
|
<!-- Start Server Selection [server] -->
|
||||||
@@ -172,14 +205,14 @@ You can override the default server globally by passing a server index to the `s
|
|||||||
|
|
||||||
| # | Server | Variables |
|
| # | Server | Variables |
|
||||||
| - | ------ | --------- |
|
| - | ------ | --------- |
|
||||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Variables
|
#### Variables
|
||||||
|
|
||||||
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
||||||
* `protocol: ::OpenApiSDK::ServerVariables::ServerProtocol`
|
* `protocol: ::PlexRubySDK::ServerVariables::ServerProtocol`
|
||||||
* `ip: ::String`
|
* `ip: ::String`
|
||||||
* `port: ::String`
|
* `port: ::String`
|
||||||
|
|
||||||
@@ -195,14 +228,19 @@ The server URL can also be overridden on a per-operation basis, provided a serve
|
|||||||
require 'plexruby'
|
require 'plexruby'
|
||||||
|
|
||||||
|
|
||||||
s = ::OpenApiSDK::PlexAPI.new(
|
s = ::PlexRubySDK::PlexAPI.new(
|
||||||
x_plex_client_identifier: "Postman",
|
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||||
)
|
)
|
||||||
|
s.config_security(
|
||||||
|
::PlexRubySDK::Shared::Security.new(
|
||||||
|
access_token: "<YOUR_API_KEY_HERE>",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
res = s.plex.get_pin(server_url: "https://plex.tv/api/v2", x_plex_product="Postman", strong=false, x_plex_client_identifier="Postman")
|
res = s.plex.get_companions_data(server_url: "https://plex.tv/api/v2/")
|
||||||
|
|
||||||
if ! res.two_hundred_and_one_application_json_object.nil?
|
if ! res.response_bodies.nil?
|
||||||
# handle response
|
# handle response
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -214,7 +252,7 @@ end
|
|||||||
|
|
||||||
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.
|
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.
|
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
### Available Globals
|
### Available Globals
|
||||||
@@ -235,14 +273,19 @@ This is used to track the client application and its usage
|
|||||||
require 'plexruby'
|
require 'plexruby'
|
||||||
|
|
||||||
|
|
||||||
s = ::OpenApiSDK::PlexAPI.new(
|
s = ::PlexRubySDK::PlexAPI.new(
|
||||||
x_plex_client_identifier: "Postman",
|
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||||
)
|
)
|
||||||
|
s.config_security(
|
||||||
|
::PlexRubySDK::Shared::Security.new(
|
||||||
|
access_token: "<YOUR_API_KEY_HERE>",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
res = s.plex.get_pin(x_plex_product="Postman", strong=false, x_plex_client_identifier="Postman")
|
res = s.plex.get_server_resources(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", include_https=::PlexRubySDK::Operations::IncludeHttps::ONE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ONE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ONE)
|
||||||
|
|
||||||
if ! res.two_hundred_and_one_application_json_object.nil?
|
if ! res.plex_devices.nil?
|
||||||
# handle response
|
# handle response
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
8
USAGE.md
8
USAGE.md
@@ -3,11 +3,11 @@
|
|||||||
require 'plexruby'
|
require 'plexruby'
|
||||||
|
|
||||||
|
|
||||||
s = ::OpenApiSDK::PlexAPI.new(
|
s = ::PlexRubySDK::PlexAPI.new(
|
||||||
x_plex_client_identifier: "Postman",
|
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
|
||||||
)
|
)
|
||||||
s.config_security(
|
s.config_security(
|
||||||
::OpenApiSDK::Shared::Security.new(
|
::PlexRubySDK::Shared::Security.new(
|
||||||
access_token: "<YOUR_API_KEY_HERE>",
|
access_token: "<YOUR_API_KEY_HERE>",
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
@@ -15,7 +15,7 @@ s.config_security(
|
|||||||
|
|
||||||
res = s.server.get_server_capabilities()
|
res = s.server.get_server_capabilities()
|
||||||
|
|
||||||
if ! res.two_hundred_application_json_object.nil?
|
if ! res.object.nil?
|
||||||
# handle response
|
# handle response
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
754
codeSamples.yaml
754
codeSamples.yaml
@@ -3,393 +3,447 @@ info:
|
|||||||
title: CodeSamples overlay for ruby target
|
title: CodeSamples overlay for ruby target
|
||||||
version: 0.0.0
|
version: 0.0.0
|
||||||
actions:
|
actions:
|
||||||
- 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:
|
|
||||||
- lang: ruby
|
|
||||||
label: getUpdateStatus
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
|
||||||
- target: $["paths"]["/updater/check"]["put"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: checkForUpdates
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::OpenApiSDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
|
|
||||||
- target: $["paths"]["/:/progress"]["post"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: updatePlayProgress
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<value>\", time=90000.0, state=\"played\")\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"]["/library/sections/{sectionId}"]["delete"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: deleteLibrary
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_id=1000.0)\n\nif res.status_code == 200\n # handle response\nend"
|
|
||||||
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: getMetadataChildren
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.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"]["/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"]["/butler"]["delete"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: stopAllTasks
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\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"]["/library/recentlyAdded"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: getRecentlyAdded
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_recently_added()\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"]["/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"]["/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"]["/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"]["/:/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"
|
|
||||||
- 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"]["/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"]["/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"]["/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"]["/search"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: getSearchResults
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.two_hundred_application_json_object.nil?\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"]["/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"]["/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"]["/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"]["/statistics/resources"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
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"]["/hubs/search"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: performSearch
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"dylan\", section_id=1516.53, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
|
|
||||||
- target: $["paths"]["/"]["get"]
|
- target: $["paths"]["/"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getServerCapabilities
|
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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_capabilities()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
- target: $["paths"]["/:/prefs"]["get"]
|
- target: $["paths"]["/:/prefs"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getServerPreferences
|
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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_preferences()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
- target: $["paths"]["/clients"]["get"]
|
- target: $["paths"]["/:/progress"]["post"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getAvailableClients
|
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.server.get_available_clients()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<key>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/myplex/account"]["get"]
|
- target: $["paths"]["/:/scrobble"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getMyPlexAccount
|
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.server.get_my_plex_account()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/:/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"]["/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"]["/video/:/transcode/universal/start.mpd"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: startUniversalTranscode
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\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"]["/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"]["/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"]["/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"]["/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"]["/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"]["/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"]["/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"]["/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"]["/:/timeline"]["get"]
|
- target: $["paths"]["/:/timeline"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getTimeline
|
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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::PlexRubySDK::Operations::State::PLAYING,\n has_mde: 1.0,\n time: 2000.0,\n duration: 10000.0,\n context: \"home:hub.continueWatching\",\n play_queue_item_id: 1.0,\n play_back_time: 2000.0,\n row: 1.0,\n)\n \nres = s.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/status/sessions/history/all"]["get"]
|
- target: $["paths"]["/:/unscrobble"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getSessionHistory
|
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.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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/updater/apply"]["put"]
|
- target: $["paths"]["/activities"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: applyUpdates
|
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.updater.apply_updates(tonight=::OpenApiSDK::Operations::Tonight::ONE, skip=::OpenApiSDK::Operations::Skip::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.get_server_activities()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
- target: $["paths"]["/transcode/sessions"]["get"]
|
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: getTranscodeSessions
|
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.sessions.get_transcode_sessions()\n\nif ! res.two_hundred_application_json_object.nil?\n # handle response\nend"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/butler"]["delete"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: stopAllTasks
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/butler"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getButlerTasks
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.get_butler_tasks()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/butler"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: startAllTasks
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/butler/{taskName}"]["delete"]
|
- target: $["paths"]["/butler/{taskName}"]["delete"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: stopTask
|
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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
- target: $["paths"]["/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"]["/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"]["/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}/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"]["/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"]["/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"]["/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"]["/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"]["/library/sections"]["get"]
|
|
||||||
update:
|
|
||||||
x-codeSamples:
|
|
||||||
- lang: ruby
|
|
||||||
label: getLibraries
|
|
||||||
source: "require 'plexruby'\n\n\ns = ::OpenApiSDK::PlexAPI.new(\n x_plex_client_identifier: \"Postman\",\n )\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_libraries()\n\nif ! res.two_hundred_application_json_object.nil?\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"]["/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::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"]["/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"]["/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"]["/butler/{taskName}"]["post"]
|
- target: $["paths"]["/butler/{taskName}"]["post"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: ruby
|
- lang: ruby
|
||||||
label: startTask
|
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"
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/clients"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getAvailableClients
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_available_clients()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/companions"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getCompanionsData
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_companions_data()\n\nif ! res.response_bodies.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/devices"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getDevices
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_devices()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/friends"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getUserFriends
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_user_friends()\n\nif ! res.friends.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/geoip"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getGeoData
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_geo_data()\n\nif ! res.geo_data.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/home"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getHomeData
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_home_data()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/hubs"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getGlobalHubs
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/hubs/search"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: performSearch
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"arnold\", section_id=9372.7, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/hubs/search/voice"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: performVoiceSearch
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_voice_search(query=\"dead+poop\", section_id=4094.8, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getLibraryHubs
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/identity"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: identity
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.server.get_server_identity()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/all/top"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getTopWatchedContent
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TWO, include_guids=1)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/hashes"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getFileHash
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: key
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: image
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetBannerImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_banner_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getMetadataChildren
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_metadata_children(rating_key=1539.14, include_elements=\"<value>\")\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: image
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetThumbImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_thumb_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/onDeck"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getOnDeck
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_on_deck()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getRecentlyAdded
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: libraries
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_all_libraries()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: list
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetWatchListRequest.new(\n filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.watchlist.get_watch_list(req)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: deleteLibrary
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_key=9518)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: details
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: metadata
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: library
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::QueryParamType::TWO)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: items
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ONE,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ONE,\n type: ::PlexRubySDK::Operations::Type::TWO,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/log"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: logLine
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/log"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: logMultiLine
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = \"level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman\"\n \nres = s.log.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/log/networked"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: enablePaperTrail
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/media/providers"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: providers
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_media_providers(x_plex_token=\"CV5xoxjTpFKUzBTShsaf\")\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/myplex/account"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getMyPlexAccount
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_my_plex_account()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getResizedPhoto
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ZERO,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/pins"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getPin
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_pin(strong=false, x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\", x_plex_product=\"Plex Web\")\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/pins/{pinID}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getTokenByPinId
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_token_by_pin_id(pin_id=408895, x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\")\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getPlaylists
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: createPlaylist
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,\n smart: ::PlexRubySDK::Operations::Smart::ONE,\n uri: \"https://inborn-brochure.biz\",\n)\n \nres = s.playlists.create_playlist(req)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/upload"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: uploadPlaylist
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::PlexRubySDK::Operations::QueryParamForce::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: deletePlaylist
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/{playlistID}"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getPlaylist
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/{playlistID}"]["put"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: updatePlaylist
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: clearPlaylistContents
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getPlaylistContents
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TWO)\n\nif ! res.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 = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.add_playlist_contents(playlist_id=8502.01, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/resources"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: resources
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_server_resources(x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\", include_https=::PlexRubySDK::Operations::IncludeHttps::ONE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ONE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ONE)\n\nif ! res.plex_devices.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/search"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getSearchResults
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/security/resources"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getSourceConnectionInformation
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/security/token"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getTransientToken
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/servers"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getServerList
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_list()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getBandwidthStatistics
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/statistics/media"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getStatistics
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/statistics/resources"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getResourcesStatistics
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_resources_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/status/sessions"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getSessions
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/status/sessions/history/all"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getSessionHistory
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/transcode/sessions"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getTranscodeSessions
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_transcode_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: stopTranscodeSession
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/updater/apply"]["put"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: applyUpdates
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/updater/check"]["put"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: checkForUpdates
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/updater/status"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getUpdateStatus
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.object.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/user"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: getTokenDetails
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_token_details()\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/users/signin"]["post"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: data
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.authentication.post_users_sign_in_data(x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n))\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
|
||||||
|
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: ruby
|
||||||
|
label: startUniversalTranscode
|
||||||
|
source: "require 'plexruby'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"
|
||||||
|
|||||||
@@ -3,13 +3,13 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||||
| `uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
| `uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
| `cancellable` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
| `cancellable` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
|
||||||
| `user_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
| `user_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
||||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
| `subtitle` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
| `subtitle` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
| `progress` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
| `progress` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A |
|
||||||
| `context` | [T.nilable(::OpenApiSDK::Operations::Context)](../../models/operations/context.md) | :heavy_minus_sign: | N/A |
|
| `context` | [T.nilable(::PlexRubySDK::Operations::Context)](../../models/operations/context.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/addplaylistcontentsbadrequest.md
Normal file
10
docs/models/operations/addplaylistcontentsbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::AddPlaylistContentsErrors](../../models/operations/addplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -3,9 +3,9 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `leaf_count_added` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
| `leaf_count_added` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `leaf_count_requested` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
| `leaf_count_requested` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)> | :heavy_minus_sign: | N/A | |
|
| `metadata` | T::Array<[::PlexRubySDK::Operations::AddPlaylistContentsMetadata](../../models/operations/addplaylistcontentsmetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
10
docs/models/operations/addplaylistcontentsplaylistserrors.md
Normal file
10
docs/models/operations/addplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# AddPlaylistContentsPlaylistsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::AddPlaylistContentsErrors](../../models/operations/addplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -3,10 +3,11 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::AddPlaylistContentsResponseBody)](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
| `object` | [T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsResponseBody)](../../models/operations/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |
|
||||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::AddPlaylistContentsPlaylistsResponseBody)](../../models/operations/addplaylistcontentsplaylistsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsBadRequest)](../../models/operations/addplaylistcontentsbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsUnauthorized)](../../models/operations/addplaylistcontentsunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -5,6 +5,6 @@ Playlist Updated
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `media_container` | [T.nilable(::OpenApiSDK::Operations::AddPlaylistContentsMediaContainer)](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
| `media_container` | [T.nilable(::PlexRubySDK::Operations::AddPlaylistContentsMediaContainer)](../../models/operations/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/addplaylistcontentsunauthorized.md
Normal file
10
docs/models/operations/addplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::AddPlaylistContentsPlaylistsErrors](../../models/operations/addplaylistcontentsplaylistserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/applyupdatesbadrequest.md
Normal file
10
docs/models/operations/applyupdatesbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::ApplyUpdatesErrors](../../models/operations/applyupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tonight` | [T.nilable(::OpenApiSDK::Operations::Tonight)](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
| `tonight` | [T.nilable(::PlexRubySDK::Operations::Tonight)](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
|
||||||
| `skip` | [T.nilable(::OpenApiSDK::Operations::Skip)](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
|
| `skip` | [T.nilable(::PlexRubySDK::Operations::Skip)](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::ApplyUpdatesResponseBody)](../../models/operations/applyupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::ApplyUpdatesBadRequest)](../../models/operations/applyupdatesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::ApplyUpdatesUnauthorized)](../../models/operations/applyupdatesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ApplyUpdatesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::ApplyUpdatesErrors](../../models/operations/applyupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/applyupdatesunauthorized.md
Normal file
10
docs/models/operations/applyupdatesunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::ApplyUpdatesUpdaterErrors](../../models/operations/applyupdatesupdatererrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/applyupdatesupdatererrors.md
Normal file
10
docs/models/operations/applyupdatesupdatererrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/autoselectsubtitle.md
Normal file
11
docs/models/operations/autoselectsubtitle.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AutoSelectSubtitle
|
||||||
|
|
||||||
|
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
9
docs/models/operations/billing.md
Normal file
9
docs/models/operations/billing.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Billing
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `internal_payment_method` | [::PlexRubySDK::Operations::InternalPaymentMethod](../../models/operations/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `payment_method_id` | *::Integer* | :heavy_check_mark: | N/A |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
| `butler_task` | T::Array<[::OpenApiSDK::Operations::ButlerTask](../../models/operations/butlertask.md)> | :heavy_minus_sign: | N/A |
|
| `butler_task` | T::Array<[::PlexRubySDK::Operations::ButlerTask](../../models/operations/butlertask.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesActivitiesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
10
docs/models/operations/cancelserveractivitiesbadrequest.md
Normal file
10
docs/models/operations/cancelserveractivitiesbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CancelServerActivitiesErrors](../../models/operations/cancelserveractivitieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::CancelServerActivitiesResponseBody)](../../models/operations/cancelserveractivitiesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::CancelServerActivitiesBadRequest)](../../models/operations/cancelserveractivitiesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::CancelServerActivitiesUnauthorized)](../../models/operations/cancelserveractivitiesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CancelServerActivitiesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::CancelServerActivitiesErrors](../../models/operations/cancelserveractivitieserrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/cancelserveractivitiesunauthorized.md
Normal file
10
docs/models/operations/cancelserveractivitiesunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CancelServerActivitiesActivitiesErrors](../../models/operations/cancelserveractivitiesactivitieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/checkforupdatesbadrequest.md
Normal file
10
docs/models/operations/checkforupdatesbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CheckForUpdatesErrors](../../models/operations/checkforupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
| `download` | [T.nilable(::OpenApiSDK::Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
| `download` | [T.nilable(::PlexRubySDK::Operations::Download)](../../models/operations/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::CheckForUpdatesResponseBody)](../../models/operations/checkforupdatesresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::CheckForUpdatesBadRequest)](../../models/operations/checkforupdatesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::CheckForUpdatesUnauthorized)](../../models/operations/checkforupdatesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CheckForUpdatesResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::CheckForUpdatesErrors](../../models/operations/checkforupdateserrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/checkforupdatesunauthorized.md
Normal file
10
docs/models/operations/checkforupdatesunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CheckForUpdatesUpdaterErrors](../../models/operations/checkforupdatesupdatererrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/checkforupdatesupdatererrors.md
Normal file
10
docs/models/operations/checkforupdatesupdatererrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
10
docs/models/operations/clearplaylistcontentsbadrequest.md
Normal file
10
docs/models/operations/clearplaylistcontentsbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::ClearPlaylistContentsErrors](../../models/operations/clearplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::ClearPlaylistContentsResponseBody)](../../models/operations/clearplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::ClearPlaylistContentsBadRequest)](../../models/operations/clearplaylistcontentsbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::ClearPlaylistContentsUnauthorized)](../../models/operations/clearplaylistcontentsunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ClearPlaylistContentsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::ClearPlaylistContentsErrors](../../models/operations/clearplaylistcontentserrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/clearplaylistcontentsunauthorized.md
Normal file
10
docs/models/operations/clearplaylistcontentsunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::ClearPlaylistContentsPlaylistsErrors](../../models/operations/clearplaylistcontentsplaylistserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
14
docs/models/operations/connections.md
Normal file
14
docs/models/operations/connections.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# Connections
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `protocol` | *::String* | :heavy_check_mark: | N/A |
|
||||||
|
| `address` | *::String* | :heavy_check_mark: | N/A |
|
||||||
|
| `port` | *::Float* | :heavy_check_mark: | N/A |
|
||||||
|
| `uri` | *::String* | :heavy_check_mark: | N/A |
|
||||||
|
| `local` | *T::Boolean* | :heavy_check_mark: | N/A |
|
||||||
|
| `relay` | *T::Boolean* | :heavy_check_mark: | N/A |
|
||||||
|
| `i_pv6` | *T::Boolean* | :heavy_check_mark: | N/A |
|
||||||
10
docs/models/operations/createplaylistbadrequest.md
Normal file
10
docs/models/operations/createplaylistbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CreatePlaylistErrors](../../models/operations/createplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 7 |
|
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 7 |
|
||||||
| `metadata` | T::Array<[::OpenApiSDK::Operations::CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)> | :heavy_minus_sign: | N/A | |
|
| `metadata` | T::Array<[::PlexRubySDK::Operations::CreatePlaylistMetadata](../../models/operations/createplaylistmetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
10
docs/models/operations/createplaylistplaylistserrors.md
Normal file
10
docs/models/operations/createplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CreatePlaylistPlaylistsResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::CreatePlaylistErrors](../../models/operations/createplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
12
docs/models/operations/createplaylistqueryparamtype.md
Normal file
12
docs/models/operations/createplaylistqueryparamtype.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# CreatePlaylistQueryParamType
|
||||||
|
|
||||||
|
type of playlist to create
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `AUDIO` | audio |
|
||||||
|
| `VIDEO` | video |
|
||||||
|
| `PHOTO` | photo |
|
||||||
@@ -3,10 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `title` | *::String* | :heavy_check_mark: | name of the playlist |
|
| `title` | *::String* | :heavy_check_mark: | name of the playlist |
|
||||||
| `type` | [::OpenApiSDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
| `type` | [::PlexRubySDK::Operations::CreatePlaylistQueryParamType](../../models/operations/createplaylistqueryparamtype.md) | :heavy_check_mark: | type of playlist to create |
|
||||||
| `smart` | [::OpenApiSDK::Operations::Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
| `smart` | [::PlexRubySDK::Operations::Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
|
||||||
| `uri` | *::String* | :heavy_check_mark: | the content URI for the playlist |
|
| `uri` | *::String* | :heavy_check_mark: | the content URI for the playlist |
|
||||||
| `play_queue_id` | *T.nilable(::Float)* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
| `play_queue_id` | *T.nilable(::Float)* | :heavy_minus_sign: | the play queue to copy to a playlist |
|
||||||
@@ -3,10 +3,11 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::CreatePlaylistResponseBody)](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
| `object` | [T.nilable(::PlexRubySDK::Operations::CreatePlaylistResponseBody)](../../models/operations/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |
|
||||||
| `four_hundred_and_one_application_json_object` | [T.nilable(::OpenApiSDK::Operations::CreatePlaylistPlaylistsResponseBody)](../../models/operations/createplaylistplaylistsresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::CreatePlaylistBadRequest)](../../models/operations/createplaylistbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::CreatePlaylistUnauthorized)](../../models/operations/createplaylistunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -5,6 +5,6 @@ returns all playlists
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `media_container` | [T.nilable(::OpenApiSDK::Operations::CreatePlaylistMediaContainer)](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
| `media_container` | [T.nilable(::PlexRubySDK::Operations::CreatePlaylistMediaContainer)](../../models/operations/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/createplaylistunauthorized.md
Normal file
10
docs/models/operations/createplaylistunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::CreatePlaylistPlaylistsErrors](../../models/operations/createplaylistplaylistserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/defaultsubtitleaccessibility.md
Normal file
11
docs/models/operations/defaultsubtitleaccessibility.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DefaultSubtitleAccessibility
|
||||||
|
|
||||||
|
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
11
docs/models/operations/defaultsubtitleforced.md
Normal file
11
docs/models/operations/defaultsubtitleforced.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DefaultSubtitleForced
|
||||||
|
|
||||||
|
The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
10
docs/models/operations/deletelibrarybadrequest.md
Normal file
10
docs/models/operations/deletelibrarybadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::DeleteLibraryErrors](../../models/operations/deletelibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/operations/deletelibrarylibraryerrors.md
Normal file
10
docs/models/operations/deletelibrarylibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
| `section_id` | *::Float* | :heavy_check_mark: | the Id of the library to query | 1000 |
|
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::DeleteLibraryResponseBody)](../../models/operations/deletelibraryresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::DeleteLibraryBadRequest)](../../models/operations/deletelibrarybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::DeleteLibraryUnauthorized)](../../models/operations/deletelibraryunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# DeleteLibraryResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::DeleteLibraryErrors](../../models/operations/deletelibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/deletelibraryunauthorized.md
Normal file
10
docs/models/operations/deletelibraryunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::DeleteLibraryLibraryErrors](../../models/operations/deletelibrarylibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/deleteplaylistbadrequest.md
Normal file
10
docs/models/operations/deleteplaylistbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::DeletePlaylistErrors](../../models/operations/deleteplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/operations/deleteplaylistplaylistserrors.md
Normal file
10
docs/models/operations/deleteplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::DeletePlaylistResponseBody)](../../models/operations/deleteplaylistresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::DeletePlaylistBadRequest)](../../models/operations/deleteplaylistbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::DeletePlaylistUnauthorized)](../../models/operations/deleteplaylistunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# DeletePlaylistResponseBody
|
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `errors` | T::Array<[::OpenApiSDK::Operations::DeletePlaylistErrors](../../models/operations/deleteplaylisterrors.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
10
docs/models/operations/deleteplaylistunauthorized.md
Normal file
10
docs/models/operations/deleteplaylistunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::DeletePlaylistPlaylistsErrors](../../models/operations/deleteplaylistplaylistserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/enablepapertrailbadrequest.md
Normal file
10
docs/models/operations/enablepapertrailbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::EnablePaperTrailErrors](../../models/operations/enablepapertrailerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/operations/enablepapertraillogerrors.md
Normal file
10
docs/models/operations/enablepapertraillogerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailLogErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -3,9 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `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 |
|
| `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 |
|
| `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::EnablePaperTrailResponseBody)](../../models/operations/enablepapertrailresponsebody.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::EnablePaperTrailBadRequest)](../../models/operations/enablepapertrailbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::EnablePaperTrailUnauthorized)](../../models/operations/enablepapertrailunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/enablepapertrailunauthorized.md
Normal file
10
docs/models/operations/enablepapertrailunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::EnablePaperTrailLogErrors](../../models/operations/enablepapertraillogerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/operations/feature.md
Normal file
10
docs/models/operations/feature.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Feature
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||||
|
| `directory` | T::Array<[::PlexRubySDK::Operations::GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md)> | :heavy_minus_sign: | N/A |
|
||||||
66
docs/models/operations/features.md
Normal file
66
docs/models/operations/features.md
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# Features
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------------------------------------- | ----------------------------------------- |
|
||||||
|
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
|
||||||
|
| `ANDROID_PI_P` | Android - PiP |
|
||||||
|
| `CU_SUNSET` | CU Sunset |
|
||||||
|
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
|
||||||
|
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
|
||||||
|
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
|
||||||
|
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
|
||||||
|
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
|
||||||
|
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
|
||||||
|
| `AVOD_NEW_MEDIA` | avod-new-media |
|
||||||
|
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
|
||||||
|
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
|
||||||
|
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
|
||||||
|
| `COLLECTIONS` | collections |
|
||||||
|
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
|
||||||
|
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
|
||||||
|
| `COMPANIONS_SONOS` | companions_sonos |
|
||||||
|
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
|
||||||
|
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
|
||||||
|
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
|
||||||
|
| `DRM_SUPPORT` | drm_support |
|
||||||
|
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
|
||||||
|
| `FEDERATED_AUTH` | federated-auth |
|
||||||
|
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
|
||||||
|
| `GUIDED_UPGRADE` | guided-upgrade |
|
||||||
|
| `HOME` | home |
|
||||||
|
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
|
||||||
|
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
|
||||||
|
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
|
||||||
|
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
|
||||||
|
| `KEVIN_BACON` | kevin-bacon |
|
||||||
|
| `KOREA_CONSENT` | korea-consent |
|
||||||
|
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
|
||||||
|
| `LETS_ENCRYPT` | lets_encrypt |
|
||||||
|
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
|
||||||
|
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
|
||||||
|
| `LIVETV` | livetv |
|
||||||
|
| `METADATA_SEARCH` | metadata_search |
|
||||||
|
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
|
||||||
|
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
|
||||||
|
| `PHOTOS_FAVORITES` | photos-favorites |
|
||||||
|
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
|
||||||
|
| `PMS_HEALTH` | pms_health |
|
||||||
|
| `RADIO` | radio |
|
||||||
|
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
|
||||||
|
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
|
||||||
|
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
|
||||||
|
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
|
||||||
|
| `SIGNIN_WITH_APPLE` | signin_with_apple |
|
||||||
|
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
|
||||||
|
| `TRANSCODER_CACHE` | transcoder_cache |
|
||||||
|
| `TUNER_SHARING` | tuner-sharing |
|
||||||
|
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
|
||||||
|
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
|
||||||
|
| `UPGRADE_3DS2` | upgrade-3ds2 |
|
||||||
|
| `VOD_SCHEMA` | vod-schema |
|
||||||
|
| `VOD_CLOUDFLARE` | vod_cloudflare |
|
||||||
|
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
|
||||||
|
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | resolution |
|
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | resolution |
|
||||||
| `operator` | T::Array<[::OpenApiSDK::Operations::Operator](../../models/operations/operator.md)> | :heavy_minus_sign: | N/A | |
|
| `operator` | T::Array<[::PlexRubySDK::Operations::Operator](../../models/operations/operator.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,11 +1,12 @@
|
|||||||
# Filter
|
# Filter
|
||||||
|
|
||||||
Filters content by field and direction/equality
|
Filter
|
||||||
(Unknown if viewedAt is the only supported column)
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
## Fields
|
| Name | Value |
|
||||||
|
| ----------- | ----------- |
|
||||||
| Field | Type | Required | Description |
|
| `ALL` | all |
|
||||||
| ----------- | ----------- | ----------- | ----------- |
|
| `AVAILABLE` | available |
|
||||||
|
| `RELEASED` | released |
|
||||||
@@ -1,10 +1,6 @@
|
|||||||
# Force
|
# Force
|
||||||
|
|
||||||
Force overwriting of duplicate playlists.
|
Force the refresh even if the library is already being refreshed.
|
||||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
|
||||||
The `force` argument is used to disable overwriting.
|
|
||||||
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|||||||
19
docs/models/operations/friend.md
Normal file
19
docs/models/operations/friend.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Friend
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| `email` | *::String* | :heavy_check_mark: | The account email address | username@email.com |
|
||||||
|
| `friendly_name` | *::String* | :heavy_check_mark: | The account full name | exampleUser |
|
||||||
|
| `home` | *T::Boolean* | :heavy_check_mark: | If the account is a Plex Home user | |
|
||||||
|
| `id` | *::Integer* | :heavy_check_mark: | The Plex account ID | |
|
||||||
|
| `restricted` | *T::Boolean* | :heavy_check_mark: | If the account is a Plex Home managed user | |
|
||||||
|
| `shared_servers` | T::Array<[::PlexRubySDK::Operations::SharedServers](../../models/operations/sharedservers.md)> | :heavy_check_mark: | N/A | |
|
||||||
|
| `shared_sources` | T::Array<[::PlexRubySDK::Operations::SharedSources](../../models/operations/sharedsources.md)> | :heavy_check_mark: | N/A | |
|
||||||
|
| `status` | [::PlexRubySDK::Operations::Status](../../models/operations/status.md) | :heavy_check_mark: | Current friend request status | accepted |
|
||||||
|
| `thumb` | *::String* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
|
||||||
|
| `title` | *::String* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
|
||||||
|
| `username` | *::String* | :heavy_check_mark: | The account username | username123 |
|
||||||
|
| `uuid` | *::String* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
|
||||||
20
docs/models/operations/geodata.md
Normal file
20
docs/models/operations/geodata.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GeoData
|
||||||
|
|
||||||
|
Geo location data
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
|
| `code` | *::String* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
|
||||||
|
| `continent_code` | *::String* | :heavy_check_mark: | The continent code where the country is located. | NA |
|
||||||
|
| `country` | *::String* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
|
||||||
|
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
|
||||||
|
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
|
||||||
|
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
|
||||||
|
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 |
|
||||||
|
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
|
||||||
|
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
|
||||||
|
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
|
||||||
|
| `coordinates` | *::String* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
|
||||||
10
docs/models/operations/getalllibrariesbadrequest.md
Normal file
10
docs/models/operations/getalllibrariesbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesErrors](../../models/operations/getalllibrarieserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
28
docs/models/operations/getalllibrariesdirectory.md
Normal file
28
docs/models/operations/getalllibrariesdirectory.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# GetAllLibrariesDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `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 |
|
||||||
|
| `composite` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||||
|
| `filters` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `refreshing` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||||
|
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||||
|
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||||
|
| `agent` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||||
|
| `scanner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||||
|
| `language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en-US |
|
||||||
|
| `uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||||
|
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||||
|
| `created_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||||
|
| `scanned_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||||
|
| `content` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `directory` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `content_changed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3192854 |
|
||||||
|
| `hidden` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
|
||||||
|
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_minus_sign: | N/A | |
|
||||||
10
docs/models/operations/getalllibrarieserrors.md
Normal file
10
docs/models/operations/getalllibrarieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/operations/getalllibrarieslibraryerrors.md
Normal file
10
docs/models/operations/getalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/getalllibrariesmediacontainer.md
Normal file
11
docs/models/operations/getalllibrariesmediacontainer.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllLibrariesMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *::Integer* | :heavy_check_mark: | N/A | 5 |
|
||||||
|
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `title1` | *::String* | :heavy_check_mark: | N/A | Plex Library |
|
||||||
|
| `directory` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
13
docs/models/operations/getalllibrariesresponse.md
Normal file
13
docs/models/operations/getalllibrariesresponse.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetAllLibrariesResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `object` | [T.nilable(::PlexRubySDK::Operations::GetAllLibrariesResponseBody)](../../models/operations/getalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
|
||||||
|
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetAllLibrariesBadRequest)](../../models/operations/getalllibrariesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||||
|
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetAllLibrariesUnauthorized)](../../models/operations/getalllibrariesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||||
10
docs/models/operations/getalllibrariesresponsebody.md
Normal file
10
docs/models/operations/getalllibrariesresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesResponseBody
|
||||||
|
|
||||||
|
The libraries available on the Server
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetAllLibrariesMediaContainer)](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getalllibrariesunauthorized.md
Normal file
10
docs/models/operations/getalllibrariesunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesLibraryErrors](../../models/operations/getalllibrarieslibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/getavailableclientsbadrequest.md
Normal file
10
docs/models/operations/getavailableclientsbadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAvailableClientsBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | T::Array<[::PlexRubySDK::Operations::GetAvailableClientsErrors](../../models/operations/getavailableclientserrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user