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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.402.14

Browse Source
This commit is contained in:
speakeasybot
2024-09-26 00:09:16 +00:00
parent 15ebc7eeca
commit 40e6afeb04
209 changed files with 4162 additions and 705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

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

12
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.401.2 speakeasyVersion: 1.402.14
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855 sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
plexruby: plexruby:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855 sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
codeSamplesNamespace: code-samples-ruby-plexruby codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:882f0cf5790d22f412dfa3648c1feb8affe2560b8fb94821ee041bcc37b40613 codeSamplesRevisionDigest: sha256:2e926a14a71aa699533691b1e736837f18fd9d63fb94993e442e01cc4391a075
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

2
Gemfile.lock
View File

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

3
README.md
View File

@@ -94,12 +94,13 @@ end
### [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_recently_added](docs/sdks/hubs/README.md#get_recently_added) - Get Recently Added
* [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
### [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_library](docs/sdks/library/README.md#get_recently_added_library) - Get Recently Added
* [get_all_libraries](docs/sdks/library/README.md#get_all_libraries) - Get All Libraries * [get_all_libraries](docs/sdks/library/README.md#get_all_libraries) - Get All Libraries
* [get_library_details](docs/sdks/library/README.md#get_library_details) - 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

12
RELEASES.md
View File

@@ -556,4 +556,14 @@ Based on:
### Generated ### Generated
- [ruby v0.4.1] . - [ruby v0.4.1] .
### Releases ### Releases
- [Ruby Gems v0.4.1] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.1 - . - [Ruby Gems v0.4.1] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.1 - .
## 2024-09-26 00:07:32
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.4.2] .
### Releases
- [Ruby Gems v0.4.2] https://rubygems.org/gems/plex_ruby_sdk/versions/0.4.2 - .

22
codeSamples.yaml
View File

@@ -123,12 +123,18 @@ actions:
- lang: ruby - lang: ruby
label: getGlobalHubs label: getGlobalHubs
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: ruby
label: added
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedRequest.new(\n content_directory_id: 470161,\n section_id: 2,\n type: ::PlexRubySDK::Operations::Type::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.hubs.get_recently_added(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/search"]["get"] - target: $["paths"]["/hubs/search"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: performSearch label: performSearch
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"dylan\", section_id=5838.67, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"dylan\", section_id=9372.69, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/search/voice"]["get"] - target: $["paths"]["/hubs/search/voice"]["get"]
update: update:
x-codeSamples: x-codeSamples:
@@ -193,8 +199,8 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getRecentlyAdded label: library
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetRecentlyAddedLibraryRequest.new(\n content_directory_id: 2,\n pinned_content_directory_id: [\n 3,\n 5,\n 7,\n 13,\n 12,\n 1,\n 6,\n 14,\n 2,\n 10,\n 16,\n 17,\n ],\n section_id: 2,\n type: ::PlexRubySDK::Operations::QueryParamType::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::QueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_recently_added_library(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"] - target: $["paths"]["/library/sections"]["get"]
update: update:
x-codeSamples: x-codeSamples:
@@ -230,13 +236,13 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: library label: library
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::QueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::GetSearchLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: items label: items
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ENABLE,\n type: ::PlexRubySDK::Operations::Type::TV_SHOW,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ENABLE,\n type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/log"]["get"] - target: $["paths"]["/log"]["get"]
update: update:
x-codeSamples: x-codeSamples:
@@ -272,7 +278,7 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getResizedPhoto label: getResizedPhoto
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 4000.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ONE,\n upscale: ::PlexRubySDK::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" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ONE,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/pins"]["post"] - target: $["paths"]["/pins"]["post"]
update: update:
x-codeSamples: x-codeSamples:
@@ -356,7 +362,7 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getSourceConnectionInformation label: getSourceConnectionInformation
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"provider://provider-identifier\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/security/token"]["get"] - target: $["paths"]["/security/token"]["get"]
update: update:
x-codeSamples: x-codeSamples:
@@ -440,7 +446,7 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: data label: data
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n\nreq = ::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n)\n \nres = s.authentication.post_users_sign_in_data(req)\n\nif ! res.user_plex_account.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n\nreq = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(\n request_body: ::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n ),\n)\n \nres = s.authentication.post_users_sign_in_data(req)\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"] - target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
update: update:
x-codeSamples: x-codeSamples:

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Peyton Reed | | `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron |

8
docs/models/operations/field.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | label | | `key` | *::String* | :heavy_check_mark: | N/A | show.title |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Label | | `title` | *::String* | :heavy_check_mark: | N/A | Show Title |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tag | | `type` | *::String* | :heavy_check_mark: | N/A | string |
| `sub_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bitrate | | `sub_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rating |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | resolution | | `type` | *::String* | :heavy_check_mark: | N/A | tag |
| `operator` | T::Array<[::PlexRubySDK::Operations::Operator](../../models/operations/operator.md)> | :heavy_minus_sign: | N/A | | | `operator` | T::Array<[::PlexRubySDK::Operations::Operator](../../models/operations/operator.md)> | :heavy_check_mark: | N/A | |

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Comedy | | `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Adventure |

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

@@ -23,6 +23,6 @@
| `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `content` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | N/A | 3192854 | | `content_changed_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 | | `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_check_mark: | N/A | | | `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,11 @@
# GetLibraryDetailsField
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | label |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Label |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tag |
| `sub_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bitrate |

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

@@ -0,0 +1,9 @@
# GetLibraryDetailsFieldType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | resolution |
| `operator` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsOperator](../../models/operations/getlibrarydetailsoperator.md)> | :heavy_minus_sign: | N/A | |

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

@@ -19,4 +19,4 @@
| `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 | | `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 |
| `directory` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md)> | :heavy_minus_sign: | N/A | | | `directory` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md)> | :heavy_minus_sign: | N/A | |
| `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md)> | :heavy_minus_sign: | N/A | | | `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md)> | :heavy_minus_sign: | N/A | |
| `field_type` | T::Array<[::PlexRubySDK::Operations::FieldType](../../models/operations/fieldtype.md)> | :heavy_minus_sign: | N/A | | | `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsFieldType](../../models/operations/getlibrarydetailsfieldtype.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,9 @@
# GetLibraryDetailsOperator
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | = |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | is |

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

@@ -0,0 +1,13 @@
# GetLibraryDetailsSort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
| `default_direction` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | desc |
| `desc_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | random:desc |
| `first_character_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1/firstCharacter |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | random |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Randomly |

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

@@ -10,5 +10,5 @@
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies | | `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | T::Array<[::PlexRubySDK::Operations::Sort](../../models/operations/sort.md)> | :heavy_minus_sign: | N/A | | | `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsSort](../../models/operations/getlibrarydetailssort.md)> | :heavy_minus_sign: | N/A | |
| `field` | T::Array<[::PlexRubySDK::Operations::Field](../../models/operations/field.md)> | :heavy_minus_sign: | N/A | | | `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryDetailsField](../../models/operations/getlibrarydetailsfield.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

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

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

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

@@ -0,0 +1,12 @@
# GetLibraryItemsDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

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

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

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

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

10
docs/models/operations/getlibraryitemsimage.md
View File

@@ -3,8 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `alt` | *::String* | :heavy_check_mark: | N/A | Episode 1 | | `alt` | *::String* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [::PlexRubySDK::Operations::GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background | | `type` | [::PlexRubySDK::Operations::GetLibraryItemsLibraryResponse200Type](../../models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
| `url` | *::String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 | | `url` | *::String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

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

@@ -0,0 +1,11 @@
# GetLibraryItemsLibraryField
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | show.title |
| `title` | *::String* | :heavy_check_mark: | N/A | Show Title |
| `type` | *::String* | :heavy_check_mark: | N/A | string |
| `sub_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rating |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsLibraryFieldType
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `type` | *::String* | :heavy_check_mark: | N/A | tag |
| `operator` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryOperator](../../models/operations/getlibraryitemslibraryoperator.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter` | *::String* | :heavy_check_mark: | N/A | genre |
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsLibraryOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *::String* | :heavy_check_mark: | N/A | = |
| `title` | *::String* | :heavy_check_mark: | N/A | is |

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

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

17
docs/models/operations/getlibraryitemslibraryresponsetype.md
View File

@@ -1,11 +1,14 @@
# GetLibraryItemsLibraryResponseType # GetLibraryItemsLibraryResponseType
## Values ## Fields
| Name | Value | | Field | Type | Required | Description | Example |
| -------------- | -------------- | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `COVER_POSTER` | coverPoster | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `BACKGROUND` | background | | `type` | *::String* | :heavy_check_mark: | N/A | show |
| `SNAPSHOT` | snapshot | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `CLEAR_LOGO` | clearLogo | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md)> | :heavy_minus_sign: | N/A | |
| `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryField](../../models/operations/getlibraryitemslibraryfield.md)> | :heavy_minus_sign: | N/A | |

15
docs/models/operations/getlibraryitemslibrarysort.md Normal file
View File

@@ -0,0 +1,15 @@
# GetLibraryItemsLibrarySort
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsLibraryActiveDirection)](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [::PlexRubySDK::Operations::GetLibraryItemsLibraryDefaultDirection](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *::String* | :heavy_check_mark: | N/A | titleSort |
| `title` | *::String* | :heavy_check_mark: | N/A | Title |

20
docs/models/operations/getlibraryitemslibrarytype.md
View File

@@ -1,14 +1,14 @@
# GetLibraryItemsLibraryType # GetLibraryItemsLibraryType
The type of media content
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ## Values
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show | | Name | Value |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows | | --------- | --------- |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `MOVIE` | movie |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | | | `TV_SHOW` | show |
| `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | | | `SEASON` | season |
| `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | | | `EPISODE` | episode |

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

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

51
docs/models/operations/getlibraryitemsmediacontainer.md
View File

@@ -1,28 +1,33 @@
# GetLibraryItemsMediaContainer # GetLibraryItemsMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 70 | | `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)> | :heavy_minus_sign: | N/A | |
| `total_size` | *::Integer* | :heavy_check_mark: | N/A | 170 | | `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)> | :heavy_minus_sign: | N/A | |
| `offset` | *::Integer* | :heavy_check_mark: | N/A | 0 | | `size` | *::Integer* | :heavy_check_mark: | N/A | 70 |
| `content` | *::String* | :heavy_check_mark: | N/A | secondary | | `total_size` | *::Integer* | :heavy_check_mark: | N/A | 170 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `offset` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `nocache` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true | | `content` | *::String* | :heavy_check_mark: | N/A | secondary |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `nocache` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `library_section_id` | *::Object* | :heavy_check_mark: | N/A | | | `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `library_section_title` | *::String* | :heavy_check_mark: | N/A | Movies | | `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `library_section_uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `library_section_id` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `media_tag_prefix` | *::String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ | | `library_section_title` | *::String* | :heavy_check_mark: | N/A | Movies |
| `media_tag_version` | *::Integer* | :heavy_check_mark: | N/A | 1701731894 | | `library_section_uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `media_tag_prefix` | *::String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `title1` | *::String* | :heavy_check_mark: | N/A | Movies | | `media_tag_version` | *::Integer* | :heavy_check_mark: | N/A | 1701731894 |
| `title2` | *::String* | :heavy_check_mark: | N/A | Recently Released | | `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `view_group` | *::String* | :heavy_check_mark: | N/A | movie | | `title1` | *::String* | :heavy_check_mark: | N/A | Movies |
| `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 | | `title2` | *::String* | :heavy_check_mark: | N/A | Recently Released |
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true | | `view_group` | *::String* | :heavy_check_mark: | N/A | movie |
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_check_mark: | N/A | | | `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 |
| `meta` | [T.nilable(::PlexRubySDK::Operations::Meta)](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | | | `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_check_mark: | N/A | |
| `meta` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsMeta)](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

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

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

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

@@ -0,0 +1,12 @@
# GetLibraryItemsMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md)> | :heavy_minus_sign: | N/A |
| `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md)> | :heavy_minus_sign: | N/A |

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

@@ -10,7 +10,10 @@
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios | | `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `type` | [::PlexRubySDK::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | The type of media content<br/> | movie | | `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [::PlexRubySDK::Operations::GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas | | `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 | | `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
@@ -20,8 +23,8 @@
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. | | `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 | | `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsFlattenSeasons)](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd | | `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsShowOrdering)](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
@@ -38,6 +41,7 @@
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica | | `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
@@ -46,10 +50,11 @@
| `country` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)> | :heavy_minus_sign: | N/A | | | `country` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)> | :heavy_minus_sign: | N/A | | | `director` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | | | `writer` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::Collection](../../models/operations/collection.md)> | :heavy_minus_sign: | N/A | | | `collection` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | | | `role` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `media_guid` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMediaGuid](../../models/operations/getlibraryitemsmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::UltraBlurColors)](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors)](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)> | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)> | :heavy_minus_sign: | N/A | | | `image` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)> | :heavy_minus_sign: | N/A | |
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale | | `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 | | `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
# GetLibraryItemsQueryParamIncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

19
docs/models/operations/getlibraryitemsqueryparamtype.md Normal file
View File

@@ -0,0 +1,19 @@
# GetLibraryItemsQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |

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

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

11
docs/models/operations/getlibraryitemsrole.md
View File

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

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

@@ -0,0 +1,20 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------- | ------------- |
| `NONE` | None |
| `TMDB_AIRING` | tmdbAiring |
| `AIRED` | aired |
| `DVD` | dvd |
| `ABSOLUTE` | absolute |

20
docs/models/operations/getlibraryitemssort.md
View File

@@ -3,13 +3,13 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc | | `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [T.nilable(::PlexRubySDK::Operations::ActiveDirection)](../../models/operations/activedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `active_direction` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsActiveDirection)](../../models/operations/getlibraryitemsactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [::PlexRubySDK::Operations::DefaultDirection](../../models/operations/defaultdirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `default_direction` | [::PlexRubySDK::Operations::GetLibraryItemsDefaultDirection](../../models/operations/getlibraryitemsdefaultdirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | titleSort:desc | | `desc_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `first_character_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *::String* | :heavy_check_mark: | N/A | titleSort | | `key` | *::String* | :heavy_check_mark: | N/A | titleSort |
| `title` | *::String* | :heavy_check_mark: | N/A | Title | | `title` | *::String* | :heavy_check_mark: | N/A | Title |

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

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

20
docs/models/operations/getlibraryitemstype.md
View File

@@ -1,14 +1,14 @@
# GetLibraryItemsType # GetLibraryItemsType
The type of media content
## Fields
| Field | Type | Required | Description | Example |
## Values | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| Name | Value | | `type` | *::String* | :heavy_check_mark: | N/A | show |
| --------- | --------- | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `MOVIE` | movie | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `TV_SHOW` | show | | `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | |
| `SEASON` | season | | `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | |
| `EPISODE` | episode | | `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | |

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

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

26
docs/models/operations/getmetadatabyratingkeypart.md
View File

@@ -3,16 +3,16 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 15 | | `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 15 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 | | `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
| `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 | | `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40271948 | | `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40271948 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc | | `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |
| `stream` | T::Array<[::PlexRubySDK::Operations::Stream](../../models/operations/stream.md)> | :heavy_minus_sign: | N/A | | | `stream` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyStream](../../models/operations/getmetadatabyratingkeystream.md)> | :heavy_minus_sign: | N/A | |

39
docs/models/operations/getmetadatabyratingkeystream.md Normal file
View File

@@ -0,0 +1,39 @@
# GetMetaDataByRatingKeyStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 29 |
| `stream_type` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | aac |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 128 |
| `bit_depth` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 8 |
| `chroma_location` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | left |
| `chroma_subsampling` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 14520 |
| `coded_height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 816 |
| `coded_width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
| `color_primaries` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
| `color_range` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tv |
| `color_space` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
| `color_trc` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
| `frame_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 24 |
| `has_scaling_matrix` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 814 |
| `level` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40 |
| `profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 4 |
| `scan_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive |
| `stream_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
| `display_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `extended_display_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `selected` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
| `language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English |
| `language_tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
| `language_code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eng |
| `sampling_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 44100 |

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

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

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

10
docs/models/operations/getrecentlyaddedbadrequest.md
View File

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

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `ASCENDING` | asc |
| `DESCENDING` | desc |

10
docs/models/operations/getrecentlyaddederrors.md
View File

@@ -1,10 +0,0 @@
# GetRecentlyAddedErrors
## 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 |

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

@@ -0,0 +1,11 @@
# GetRecentlyAddedField
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | show.title |
| `title` | *::String* | :heavy_check_mark: | N/A | Show Title |
| `type` | *::String* | :heavy_check_mark: | N/A | string |
| `sub_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rating |

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

@@ -0,0 +1,9 @@
# GetRecentlyAddedFieldType
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `type` | *::String* | :heavy_check_mark: | N/A | tag |
| `operator` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedOperator](../../models/operations/getrecentlyaddedoperator.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter` | *::String* | :heavy_check_mark: | N/A | genre |
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter |

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

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

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

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

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

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

4
docs/models/operations/getrecentlyaddedunauthorized.md → docs/models/operations/getrecentlyaddedlibrarybadrequest.md
View File

@@ -1,6 +1,6 @@
# GetRecentlyAddedUnauthorized # GetRecentlyAddedLibraryBadRequest
Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields ## Fields

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

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

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

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

10
docs/models/operations/getrecentlyaddedlibraryerrors.md
View File

@@ -3,8 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *T.nilable(::Integer)* | :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(::Integer)* | :heavy_minus_sign: | N/A | 401 | | `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter` | *::String* | :heavy_check_mark: | N/A | genre |
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter |

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

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

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

@@ -0,0 +1,10 @@
# GetRecentlyAddedLibraryLibraryErrors
## 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 |

23
docs/models/operations/getrecentlyaddedlibrarymedia.md Normal file
View File

@@ -0,0 +1,23 @@
# GetRecentlyAddedLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 120345 |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 |
| `bitrate` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 3623 |
| `width` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 804 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2.35 |
| `audio_channels` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 6 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | ac3 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | h264 |
| `video_resolution` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `optimized_for_streaming` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |
| `part` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryPart](../../models/operations/getrecentlyaddedlibrarypart.md)> | :heavy_minus_sign: | N/A | |

19
docs/models/operations/getrecentlyaddedlibrarymediacontainer.md Normal file
View File

@@ -0,0 +1,19 @@
# GetRecentlyAddedLibraryMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `type` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryType](../../models/operations/getrecentlyaddedlibrarytype.md)> | :heavy_minus_sign: | N/A | |
| `field_type` | T::Array<[::PlexRubySDK::Operations::FieldType](../../models/operations/fieldtype.md)> | :heavy_minus_sign: | N/A | |
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 50 |
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `media_tag_version` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryMetadata](../../models/operations/getrecentlyaddedlibrarymetadata.md)> | :heavy_minus_sign: | N/A | |

39
docs/models/operations/getrecentlyaddedlibrarymetadata.md Normal file
View File

@@ -0,0 +1,39 @@
# GetRecentlyAddedLibraryMetadata
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `library_section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `rating_key` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 59398 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Marvel Studios |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 4.7 |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.3 |
| `year` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2023 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 |
| `originally_available_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
| `added_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681803215 |
| `updated_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681888010 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
| `media` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryMedia](../../models/operations/getrecentlyaddedlibrarymedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryGenre](../../models/operations/getrecentlyaddedlibrarygenre.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryDirector](../../models/operations/getrecentlyaddedlibrarydirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryWriter](../../models/operations/getrecentlyaddedlibrarywriter.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryCountry](../../models/operations/getrecentlyaddedlibrarycountry.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryRole](../../models/operations/getrecentlyaddedlibraryrole.md)> | :heavy_minus_sign: | N/A | |

17
docs/models/operations/getrecentlyaddedlibrarypart.md Normal file
View File

@@ -0,0 +1,17 @@
# GetRecentlyAddedLibraryPart
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 120353 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 |
| `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 3395307162 |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `has_thumbnail` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content_directory_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
| `pinned_content_directory_id` | T::Array<*::Integer*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [::PlexRubySDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeMeta)](../../models/operations/queryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

@@ -0,0 +1,13 @@
# GetRecentlyAddedLibraryResponse
## 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::GetRecentlyAddedLibraryResponseBody)](../../models/operations/getrecentlyaddedlibraryresponsebody.md) | :heavy_minus_sign: | The recently added content |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedLibraryBadRequest)](../../models/operations/getrecentlyaddedlibrarybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedLibraryUnauthorized)](../../models/operations/getrecentlyaddedlibraryunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

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

@@ -0,0 +1,10 @@
# GetRecentlyAddedLibraryResponseBody
The recently added content
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedLibraryMediaContainer)](../../models/operations/getrecentlyaddedlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

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

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

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | T::Array<[::PlexRubySDK::Operations::Sort](../../models/operations/sort.md)> | :heavy_minus_sign: | N/A | |
| `field` | T::Array<[::PlexRubySDK::Operations::Field](../../models/operations/field.md)> | :heavy_minus_sign: | N/A | |

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

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

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

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

10
docs/models/operations/getrecentlyaddedmediacontainer.md
View File

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 50 | | `size` | *::Float* | :heavy_check_mark: | N/A | 50 |
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | | | `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library | | `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ | | `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `media_tag_version` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1680021154 | | `meta` | [T.nilable(::PlexRubySDK::Operations::Meta)](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | |
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md)> | :heavy_minus_sign: | N/A | | | `metadata` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedMetadata](../../models/operations/getrecentlyaddedmetadata.md)> | :heavy_minus_sign: | N/A | |

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

@@ -3,37 +3,78 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | | | `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `library_section_id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies | | `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `rating_key` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 59398 | | `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398 | | `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 | | `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Marvel Studios | | `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie | | `type` | [::PlexRubySDK::Operations::GetRecentlyAddedHubsType](../../models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania | | `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 | | `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. | | `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 4.7 | | `summary` | *::String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.3 | | `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.6 |
| `year` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2023 | | `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. | | `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 | | `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 | | `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 | | `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `originally_available_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC | | `show_ordering` | [T.nilable(::PlexRubySDK::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `added_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681803215 | | `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `updated_at` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1681888010 | | `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/59399 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten | | `added_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `media` | T::Array<[::PlexRubySDK::Operations::Media](../../models/operations/media.md)> | :heavy_minus_sign: | N/A | | | `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `genre` | T::Array<[::PlexRubySDK::Operations::Genre](../../models/operations/genre.md)> | :heavy_minus_sign: | N/A | | | `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `director` | T::Array<[::PlexRubySDK::Operations::Director](../../models/operations/director.md)> | :heavy_minus_sign: | N/A | | | `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
| `writer` | T::Array<[::PlexRubySDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | | | `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `country` | T::Array<[::PlexRubySDK::Operations::Country](../../models/operations/country.md)> | :heavy_minus_sign: | N/A | | | `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `role` | T::Array<[::PlexRubySDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | | | `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | T::Array<[::PlexRubySDK::Operations::Media](../../models/operations/media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | T::Array<[::PlexRubySDK::Operations::Genre](../../models/operations/genre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::PlexRubySDK::Operations::Country](../../models/operations/country.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::Director](../../models/operations/director.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::Collection](../../models/operations/collection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::UltraBlurColors)](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::MetaDataRating](../../models/operations/metadatarating.md)> | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedImage](../../models/operations/getrecentlyaddedimage.md)> | :heavy_minus_sign: | N/A | |
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

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

@@ -0,0 +1,9 @@
# GetRecentlyAddedOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *::String* | :heavy_check_mark: | N/A | = |
| `title` | *::String* | :heavy_check_mark: | N/A | is |

5
docs/models/operations/getrecentlyaddedrequest.md
View File

@@ -5,5 +5,10 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content_directory_id` | *::Integer* | :heavy_check_mark: | The content directory ID. | |
| `pinned_content_directory_id` | *T.nilable(::String)* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [::PlexRubySDK::Operations::Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::IncludeMeta)](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | | `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

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

@@ -8,6 +8,4 @@
| `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(::PlexRubySDK::Operations::GetRecentlyAddedResponseBody)](../../models/operations/getrecentlyaddedresponsebody.md) | :heavy_minus_sign: | The recently added content | | `object` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedResponseBody)](../../models/operations/getrecentlyaddedresponsebody.md) | :heavy_minus_sign: | A successful response with recently added content. |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedBadRequest)](../../models/operations/getrecentlyaddedbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedUnauthorized)](../../models/operations/getrecentlyaddedunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

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

@@ -1,6 +1,6 @@
# GetRecentlyAddedResponseBody # GetRecentlyAddedResponseBody
The recently added content A successful response with recently added content.
## Fields ## Fields

15
docs/models/operations/getrecentlyaddedsort.md Normal file
View File

@@ -0,0 +1,15 @@
# GetRecentlyAddedSort
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `active_direction` | [T.nilable(::PlexRubySDK::Operations::GetRecentlyAddedActiveDirection)](../../models/operations/getrecentlyaddedactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `default_direction` | [::PlexRubySDK::Operations::GetRecentlyAddedDefaultDirection](../../models/operations/getrecentlyaddeddefaultdirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `desc_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | titleSort:desc |
| `first_character_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *::String* | :heavy_check_mark: | N/A | titleSort |
| `title` | *::String* | :heavy_check_mark: | N/A | Title |

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedSort](../../models/operations/getrecentlyaddedsort.md)> | :heavy_minus_sign: | N/A | |
| `field` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedField](../../models/operations/getrecentlyaddedfield.md)> | :heavy_minus_sign: | N/A | |

19
docs/models/operations/getsearchlibraryqueryparamtype.md Normal file
View File

@@ -0,0 +1,19 @@
# GetSearchLibraryQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | 1 |
| `TV_SHOW` | 2 |
| `SEASON` | 3 |
| `EPISODE` | 4 |

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

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `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 |
| `type` | [::PlexRubySDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 | | `type` | [::PlexRubySDK::Operations::GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -3,21 +3,23 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 120345 | | `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 | | `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 3623 | | `bitrate` | *::Integer* | :heavy_check_mark: | N/A | 25025 |
| `width` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1920 | | `width` | *::Integer* | :heavy_check_mark: | N/A | 3840 |
| `height` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 804 | | `height` | *::Integer* | :heavy_check_mark: | N/A | 2072 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2.35 | | `aspect_ratio` | *::Float* | :heavy_check_mark: | N/A | 1.85 |
| `audio_channels` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 6 | | `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | ac3 | | `audio_channels` | *::Integer* | :heavy_check_mark: | N/A | 6 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | h264 | | `audio_codec` | *::String* | :heavy_check_mark: | N/A | eac3 |
| `video_resolution` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1080 | | `video_codec` | *::String* | :heavy_check_mark: | N/A | hevc |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 | | `video_resolution` | *::String* | :heavy_check_mark: | N/A | 4k |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p | | `container` | *::String* | :heavy_check_mark: | N/A | mkv |
| `optimized_for_streaming` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 0 | | `video_frame_rate` | *::String* | :heavy_check_mark: | N/A | 24p |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | | | `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high | | `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::Part](../../models/operations/part.md)> | :heavy_minus_sign: | N/A | | | `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::OptimizedForStreaming)](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::Part](../../models/operations/part.md)> | :heavy_check_mark: | N/A | |

8
docs/models/operations/meta.md
View File

@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md)> | :heavy_minus_sign: | N/A | | `type` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedType](../../models/operations/getrecentlyaddedtype.md)> | :heavy_minus_sign: | N/A |
| `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)> | :heavy_minus_sign: | N/A | | `field_type` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedFieldType](../../models/operations/getrecentlyaddedfieldtype.md)> | :heavy_minus_sign: | N/A |

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

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

8
docs/models/operations/operator.md
View File

@@ -3,7 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | = | | `key` | *::String* | :heavy_check_mark: | N/A | = |
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | is | | `title` | *::String* | :heavy_check_mark: | N/A | is |

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

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

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

@@ -3,15 +3,18 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 120353 | | `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7474422 | | `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
| `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 | | `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 3395307162 | | `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 | | `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | | | `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has_thumbnail` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1 | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | | | `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high | | `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::HasThumbnail)](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::Stream](../../models/operations/stream.md)> | :heavy_minus_sign: | N/A | |

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

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

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

@@ -0,0 +1,12 @@
# QueryParamIncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

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