mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1
This commit is contained in:
speakeasybot
File diff suppressed because one or more lines are too long
@@ -13,7 +13,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
oAuth2PasswordEnabled: false
|
||||
ruby:
|
||||
version: 0.7.3
|
||||
version: 0.7.4
|
||||
author: LukeHagar
|
||||
description: Ruby Client SDK Generated by Speakeasy
|
||||
imports:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.487.0
|
||||
speakeasyVersion: 1.487.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,19 +9,19 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1738886888
|
||||
- speakeasy-sdk-regen-1738973265
|
||||
targets:
|
||||
plexruby:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
||||
codeSamplesNamespace: code-samples-ruby-plexruby
|
||||
codeSamplesRevisionDigest: sha256:d208b8865c0f8cf051965436cf2d8c2215b12e221e9f425a7862e3ceb846fb96
|
||||
codeSamplesRevisionDigest: sha256:eac592b001aa961d7be4bd82b03336ae654e260261abc5548faf1b199b6eea16
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
plex_ruby_sdk (0.7.3)
|
||||
plex_ruby_sdk (0.7.4)
|
||||
faraday
|
||||
faraday-multipart
|
||||
rack
|
||||
|
||||
@@ -135,8 +135,9 @@ end
|
||||
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
|
||||
* [get_genres_library](docs/sdks/library/README.md#get_genres_library) - Get Genres of library media
|
||||
* [get_countries_library](docs/sdks/library/README.md#get_countries_library) - Get Countries of library media
|
||||
* [get_actors_library](docs/sdks/library/README.md#get_actors_library) - Get Actors of library media
|
||||
* [get_search_all_libraries](docs/sdks/library/README.md#get_search_all_libraries) - Search All Libraries
|
||||
* [get_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||
* [get_media_meta_data](docs/sdks/library/README.md#get_media_meta_data) - Get Media Metadata
|
||||
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||
|
||||
10
RELEASES.md
10
RELEASES.md
@@ -707,3 +707,13 @@ Based on:
|
||||
- [ruby v0.7.3] .
|
||||
### Releases
|
||||
- [Ruby Gems v0.7.3] https://rubygems.org/gems/plex_ruby_sdk/versions/0.7.3 - .
|
||||
|
||||
## 2025-02-08 00:07:29
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [ruby v0.7.4] .
|
||||
### Releases
|
||||
- [Ruby Gems v0.7.4] https://rubygems.org/gems/plex_ruby_sdk/versions/0.7.4 - .
|
||||
@@ -169,8 +169,8 @@ actions:
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: key
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
label: data
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetMediaMetaDataRequest.new(\n rating_key: 9518,\n include_concerts: true,\n include_extras: true,\n include_on_deck: true,\n include_popular_leaves: true,\n include_preferences: true,\n include_reviews: true,\n include_chapters: true,\n include_stations: true,\n include_external_media: true,\n async_augment_metadata: true,\n async_check_files: true,\n async_refresh_analysis: true,\n async_refresh_local_media_agent: true,\n)\n \nres = s.library.get_media_meta_data(req)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
@@ -231,18 +231,24 @@ actions:
|
||||
- lang: ruby
|
||||
label: details
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: library
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_actors_library(section_key=9518, type=::PlexRubySDK::Operations::GetActorsLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: library
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_countries_library(section_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_countries_library(section_key=9518, type=::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: ruby
|
||||
label: library
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_genres_library(section_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_genres_library(section_key=9518, type=::PlexRubySDK::Operations::GetGenresLibraryQueryParamType::TV_SHOW)\n\nif ! res.object.nil?\n # handle response\nend"
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
|
||||
10
docs/models/operations/getactorslibrarybadrequest.md
Normal file
10
docs/models/operations/getactorslibrarybadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetActorsLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryErrors](../../models/operations/getactorslibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `fast_key` | *::String* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||
| `key` | *::String* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||
| `title` | *::String* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetActorsLibraryMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *::String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `view_mode` | *::String* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetActorsLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
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 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
9
docs/models/operations/getactorslibraryrequest.md
Normal file
9
docs/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetActorsLibraryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetActorsLibraryQueryParamType](../../models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
13
docs/models/operations/getactorslibraryresponse.md
Normal file
13
docs/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
|
||||
## 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::GetActorsLibraryResponseBody)](../../models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryBadRequest)](../../models/operations/getactorslibrarybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryUnauthorized)](../../models/operations/getactorslibraryunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetActorsLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryMediaContainer)](../../models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
@@ -6,5 +6,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyLibraryErrors](../../models/operations/getmetadatabyratingkeylibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryLibraryErrors](../../models/operations/getactorslibrarylibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetCountriesLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
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 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -4,5 +4,6 @@
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType](../../models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetGenresLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
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 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -4,5 +4,6 @@
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetGenresLibraryQueryParamType](../../models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetLibraryItemsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -4,10 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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` | [::PlexRubySDK::Operations::GetLibraryItemsQueryParamType](../../models/operations/getlibraryitemsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|
||||
10
docs/models/operations/getmediametadatabadrequest.md
Normal file
10
docs/models/operations/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataErrors](../../models/operations/getmediametadataerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmediametadatacountry.md
Normal file
10
docs/models/operations/getmediametadatacountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The country name. | United States of America |
|
||||
13
docs/models/operations/getmediametadatadirector.md
Normal file
13
docs/models/operations/getmediametadatadirector.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
10
docs/models/operations/getmediametadataerrors.md
Normal file
10
docs/models/operations/getmediametadataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/operations/getmediametadatagenre.md
Normal file
10
docs/models/operations/getmediametadatagenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The genre name. | Crime |
|
||||
10
docs/models/operations/getmediametadataimage.md
Normal file
10
docs/models/operations/getmediametadataimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `alt` | *::String* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||
| `url` | *::String* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||
10
docs/models/operations/getmediametadatalibraryerrors.md
Normal file
10
docs/models/operations/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
8
docs/models/operations/getmediametadatalocation.md
Normal file
8
docs/models/operations/getmediametadatalocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaMetaDataLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `path` | *::String* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |
|
||||
22
docs/models/operations/getmediametadatamedia.md
Normal file
22
docs/models/operations/getmediametadatamedia.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetMediaMetaDataMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *::Integer* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
||||
| `height` | *::Integer* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *::Float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *::Integer* | :heavy_check_mark: | Number of audio channels. | 6 |
|
||||
| `audio_codec` | *::String* | :heavy_check_mark: | Audio codec used. | eac3 |
|
||||
| `video_codec` | *::String* | :heavy_check_mark: | Video codec used. | hevc |
|
||||
| `video_resolution` | *::String* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *::String* | :heavy_check_mark: | File container type. | mkv |
|
||||
| `video_frame_rate` | *::String* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *T::Boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetMediaMetaDataMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *::Integer* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataMetadata](../../models/operations/getmediametadatametadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
||||
@@ -1,45 +1,66 @@
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
# GetMediaMetaDataMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `added_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMedia](../../models/operations/getmetadatabyratingkeymedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyGenre](../../models/operations/getmetadatabyratingkeygenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyCountry](../../models/operations/getmetadatabyratingkeycountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | T::Array<[::PlexRubySDK::Operations::Ratings](../../models/operations/ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyDirector](../../models/operations/getmetadatabyratingkeydirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyWriter](../../models/operations/getmetadatabyratingkeywriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyRole](../../models/operations/getmetadatabyratingkeyrole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | T::Array<[::PlexRubySDK::Operations::Producer](../../models/operations/producer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *::String* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
||||
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
||||
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
||||
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
||||
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
||||
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
||||
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
||||
| `key` | *::String* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
||||
| `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
||||
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
||||
| `title` | *::String* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
||||
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_id` | *::Integer* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||
| `library_section_key` | *::String* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||
| `content_rating` | *::String* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
|
||||
| `summary` | *::String* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||
| `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
|
||||
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||
| `year` | *::Integer* | :heavy_check_mark: | The release year. | 2015 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| `art` | *::String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_check_mark: | The original release date. | 2015-02-08 |
|
||||
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||
| `added_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
|
||||
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
||||
| `audience_rating_image` | *::String* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)> | :heavy_check_mark: | An array of image objects. | |
|
||||
| `ultra_blur_colors` | [::PlexRubySDK::Operations::GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
||||
| `genre` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
|
||||
| `country` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)> | :heavy_minus_sign: | An array of country tags. | |
|
||||
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_check_mark: | An array of GUID objects. | |
|
||||
| `rating` | T::Array<[::PlexRubySDK::Operations::Rating](../../models/operations/rating.md)> | :heavy_check_mark: | An array of rating objects. | |
|
||||
| `role` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `director` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `writer` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `producer` | T::Array<[::PlexRubySDK::Operations::Producer](../../models/operations/producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | T::Array<[::PlexRubySDK::Operations::Similar](../../models/operations/similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `location` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
||||
18
docs/models/operations/getmediametadatapart.md
Normal file
18
docs/models/operations/getmediametadatapart.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *::String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *::String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *::Integer* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `container` | *::String* | :heavy_check_mark: | Container format of the part. | mkv |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | Video profile for the part. | main 10 |
|
||||
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_check_mark: | An array of streams for this part. | |
|
||||
21
docs/models/operations/getmediametadatarequest.md
Normal file
21
docs/models/operations/getmediametadatarequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `rating_key` | *::Integer* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| `include_concerts` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
||||
| `include_extras` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
||||
| `include_on_deck` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include on-deck items. | true |
|
||||
| `include_popular_leaves` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
||||
| `include_preferences` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include preferences information. | true |
|
||||
| `include_reviews` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include reviews for the content. | true |
|
||||
| `include_chapters` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include chapter details. | true |
|
||||
| `include_stations` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include station data. | true |
|
||||
| `include_external_media` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include external media data. | true |
|
||||
| `async_augment_metadata` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
||||
| `async_check_files` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
||||
| `async_refresh_analysis` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
||||
| `async_refresh_local_media_agent` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
|
||||
13
docs/models/operations/getmediametadataresponse.md
Normal file
13
docs/models/operations/getmediametadataresponse.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataResponse
|
||||
|
||||
|
||||
## 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::GetMediaMetaDataResponseBody)](../../models/operations/getmediametadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataBadRequest)](../../models/operations/getmediametadatabadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataUnauthorized)](../../models/operations/getmediametadataunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyResponseBody
|
||||
# GetMediaMetaDataResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
@@ -6,5 +6,5 @@ The metadata of the library item.
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyMediaContainer)](../../models/operations/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataMediaContainer)](../../models/operations/getmediametadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmediametadatarole.md
Normal file
13
docs/models/operations/getmediametadatarole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
53
docs/models/operations/getmediametadatastream.md
Normal file
53
docs/models/operations/getmediametadatastream.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# GetMediaMetaDataStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `stream_type` | *::Integer* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *::String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *::Integer* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *::String* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `language_tag` | *::String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *::String* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `dovibl_compat_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *T.nilable(::String)* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *T.nilable(::String)* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *T.nilable(::String)* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `color_primaries` | *T.nilable(::String)* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *T.nilable(::String)* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *T.nilable(::String)* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *T.nilable(::String)* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *T.nilable(::Float)* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *::String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *::String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *T.nilable(::String)* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataUltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `top_left` | *::String* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||
| `top_right` | *::String* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||
| `bottom_right` | *::String* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||
| `bottom_left` | *::String* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||
10
docs/models/operations/getmediametadataunauthorized.md
Normal file
10
docs/models/operations/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataLibraryErrors](../../models/operations/getmediametadatalibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmediametadatawriter.md
Normal file
13
docs/models/operations/getmediametadatawriter.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyErrors](../../models/operations/getmetadatabyratingkeyerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 116 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | country=116 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 130 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | director=130 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 184 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | genre=184 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Thriller |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | aac |
|
||||
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `video_resolution` | *T.nilable(::String)* | :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(::Integer)* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyPart](../../models/operations/getmetadatabyratingkeypart.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `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_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMetadata](../../models/operations/getmetadatabyratingkeymetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetaDataByRatingKeyPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `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 |
|
||||
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |
|
||||
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyStream](../../models/operations/getmetadatabyratingkeystream.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *::Integer* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
@@ -1,13 +0,0 @@
|
||||
# GetMetaDataByRatingKeyResponse
|
||||
|
||||
|
||||
## 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::GetMetaDataByRatingKeyResponseBody)](../../models/operations/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyBadRequest)](../../models/operations/getmetadatabyratingkeybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyUnauthorized)](../../models/operations/getmetadatabyratingkeyunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
@@ -1,13 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | actor=220 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||
@@ -1,39 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 132 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | writer=132 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetPlaylistContentsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.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::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
@@ -4,11 +4,11 @@
|
||||
## 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
@@ -4,11 +4,11 @@
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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_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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetSearchLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetTopWatchedContentQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.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::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
@@ -4,5 +4,5 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tvdb://2337 |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *::String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||
@@ -5,8 +5,9 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 221 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | producer=221 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Barry Mendel |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776826961905001eb90e2b |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# QueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
10
docs/models/operations/rating.md
Normal file
10
docs/models/operations/rating.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Rating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *::String* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||
| `value` | *::Float* | :heavy_check_mark: | The rating value. | 9 |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Ratings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | themoviedb://image.rating |
|
||||
| `value` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.4 |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | audience |
|
||||
10
docs/models/operations/similar.md
Normal file
10
docs/models/operations/similar.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Similar
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
@@ -1,6 +1,6 @@
|
||||
# Type
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -18,8 +18,9 @@ API Calls interacting with Plex Media Server Libraries
|
||||
* [get_search_library](#get_search_library) - Search Library
|
||||
* [get_genres_library](#get_genres_library) - Get Genres of library media
|
||||
* [get_countries_library](#get_countries_library) - Get Countries of library media
|
||||
* [get_actors_library](#get_actors_library) - Get Actors of library media
|
||||
* [get_search_all_libraries](#get_search_all_libraries) - Search All Libraries
|
||||
* [get_meta_data_by_rating_key](#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||
* [get_media_meta_data](#get_media_meta_data) - Get Media Metadata
|
||||
* [get_metadata_children](#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](#get_on_deck) - Get On Deck
|
||||
@@ -435,9 +436,9 @@ end
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -464,7 +465,7 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_genres_library(section_key=9518)
|
||||
res = s.library.get_genres_library(section_key=9518, type=::PlexRubySDK::Operations::GetGenresLibraryQueryParamType::TV_SHOW)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
@@ -475,8 +476,9 @@ end
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetGenresLibraryQueryParamType](../../models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -503,7 +505,7 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_countries_library(section_key=9518)
|
||||
res = s.library.get_countries_library(section_key=9518, type=::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType::TV_SHOW)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
@@ -514,8 +516,9 @@ end
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType](../../models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -523,6 +526,46 @@ end
|
||||
|
||||
|
||||
|
||||
## get_actors_library
|
||||
|
||||
Retrieves a list of all the actors that are found for the media in this library.
|
||||
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require 'plex_ruby_sdk'
|
||||
|
||||
|
||||
s = ::PlexRubySDK::PlexAPI.new
|
||||
s.config_security(
|
||||
::PlexRubySDK::Shared::Security.new(
|
||||
access_token: "<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_actors_library(section_key=9518, type=::PlexRubySDK::Operations::GetActorsLibraryQueryParamType::TV_SHOW)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | 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 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetActorsLibraryQueryParamType](../../models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetActorsLibraryResponse)](../../models/operations/getactorslibraryresponse.md)**
|
||||
|
||||
|
||||
|
||||
## get_search_all_libraries
|
||||
|
||||
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
|
||||
@@ -572,9 +615,9 @@ end
|
||||
|
||||
|
||||
|
||||
## get_meta_data_by_rating_key
|
||||
## get_media_meta_data
|
||||
|
||||
This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
|
||||
|
||||
|
||||
### Example Usage
|
||||
@@ -591,7 +634,24 @@ s.config_security(
|
||||
)
|
||||
|
||||
|
||||
res = s.library.get_meta_data_by_rating_key(rating_key=9518)
|
||||
req = ::PlexRubySDK::Operations::GetMediaMetaDataRequest.new(
|
||||
rating_key: 9518,
|
||||
include_concerts: true,
|
||||
include_extras: true,
|
||||
include_on_deck: true,
|
||||
include_popular_leaves: true,
|
||||
include_preferences: true,
|
||||
include_reviews: true,
|
||||
include_chapters: true,
|
||||
include_stations: true,
|
||||
include_external_media: true,
|
||||
async_augment_metadata: true,
|
||||
async_check_files: true,
|
||||
async_refresh_analysis: true,
|
||||
async_refresh_local_media_agent: true,
|
||||
)
|
||||
|
||||
res = s.library.get_media_meta_data(req)
|
||||
|
||||
if ! res.object.nil?
|
||||
# handle response
|
||||
@@ -601,13 +661,13 @@ end
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *::Integer* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| Parameter | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `request` | [::PlexRubySDK::Operations::GetMediaMetaDataRequest](../../models/operations/getmediametadatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyResponse)](../../models/operations/getmetadatabyratingkeyresponse.md)**
|
||||
**[T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataResponse)](../../models/operations/getmediametadataresponse.md)**
|
||||
|
||||
|
||||
|
||||
@@ -681,8 +741,8 @@ end
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.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::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -261,9 +261,9 @@ end
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.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::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<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 |
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -491,14 +491,15 @@ module PlexRubySDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer).returns(::PlexRubySDK::Operations::GetGenresLibraryResponse) }
|
||||
def get_genres_library(section_key)
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetGenresLibraryQueryParamType).returns(::PlexRubySDK::Operations::GetGenresLibraryResponse) }
|
||||
def get_genres_library(section_key, type)
|
||||
# get_genres_library - Get Genres of library media
|
||||
# Retrieves a list of all the genres that are found for the media in this library.
|
||||
#
|
||||
request = ::PlexRubySDK::Operations::GetGenresLibraryRequest.new(
|
||||
|
||||
section_key: section_key
|
||||
section_key: section_key,
|
||||
type: type
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
@@ -509,11 +510,13 @@ module PlexRubySDK
|
||||
request
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetGenresLibraryRequest, request)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
@@ -544,14 +547,15 @@ module PlexRubySDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer).returns(::PlexRubySDK::Operations::GetCountriesLibraryResponse) }
|
||||
def get_countries_library(section_key)
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType).returns(::PlexRubySDK::Operations::GetCountriesLibraryResponse) }
|
||||
def get_countries_library(section_key, type)
|
||||
# get_countries_library - Get Countries of library media
|
||||
# Retrieves a list of all the countries that are found for the media in this library.
|
||||
#
|
||||
request = ::PlexRubySDK::Operations::GetCountriesLibraryRequest.new(
|
||||
|
||||
section_key: section_key
|
||||
section_key: section_key,
|
||||
type: type
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
@@ -562,11 +566,13 @@ module PlexRubySDK
|
||||
request
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetCountriesLibraryRequest, request)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
@@ -597,6 +603,62 @@ module PlexRubySDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetActorsLibraryQueryParamType).returns(::PlexRubySDK::Operations::GetActorsLibraryResponse) }
|
||||
def get_actors_library(section_key, type)
|
||||
# get_actors_library - Get Actors of library media
|
||||
# Retrieves a list of all the actors that are found for the media in this library.
|
||||
#
|
||||
request = ::PlexRubySDK::Operations::GetActorsLibraryRequest.new(
|
||||
|
||||
section_key: section_key,
|
||||
type: type
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = Utils.generate_url(
|
||||
::PlexRubySDK::Operations::GetActorsLibraryRequest,
|
||||
base_url,
|
||||
'/library/sections/{sectionKey}/actor',
|
||||
request
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetActorsLibraryRequest, request)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
||||
|
||||
res = ::PlexRubySDK::Operations::GetActorsLibraryResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if r.status == 200
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetActorsLibraryResponseBody)
|
||||
res.object = out
|
||||
end
|
||||
elsif r.status == 400
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetActorsLibraryBadRequest)
|
||||
res.bad_request = out
|
||||
end
|
||||
elsif r.status == 401
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetActorsLibraryUnauthorized)
|
||||
res.unauthorized = out
|
||||
end
|
||||
elsif r.status == 404
|
||||
end
|
||||
|
||||
res
|
||||
end
|
||||
|
||||
|
||||
sig { params(request: T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesRequest)).returns(::PlexRubySDK::Operations::GetSearchAllLibrariesResponse) }
|
||||
def get_search_all_libraries(request)
|
||||
# get_search_all_libraries - Search All Libraries
|
||||
@@ -642,52 +704,51 @@ module PlexRubySDK
|
||||
end
|
||||
|
||||
|
||||
sig { params(rating_key: ::Integer).returns(::PlexRubySDK::Operations::GetMetaDataByRatingKeyResponse) }
|
||||
def get_meta_data_by_rating_key(rating_key)
|
||||
# get_meta_data_by_rating_key - Get Metadata by RatingKey
|
||||
# This endpoint will return the metadata of a library item specified with the ratingKey.
|
||||
sig { params(request: T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataRequest)).returns(::PlexRubySDK::Operations::GetMediaMetaDataResponse) }
|
||||
def get_media_meta_data(request)
|
||||
# get_media_meta_data - Get Media Metadata
|
||||
# This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
|
||||
#
|
||||
request = ::PlexRubySDK::Operations::GetMetaDataByRatingKeyRequest.new(
|
||||
|
||||
rating_key: rating_key
|
||||
)
|
||||
url, params = @sdk_configuration.get_server_details
|
||||
base_url = Utils.template_url(url, params)
|
||||
url = Utils.generate_url(
|
||||
::PlexRubySDK::Operations::GetMetaDataByRatingKeyRequest,
|
||||
::PlexRubySDK::Operations::GetMediaMetaDataRequest,
|
||||
base_url,
|
||||
'/library/metadata/{ratingKey}',
|
||||
request
|
||||
)
|
||||
headers = {}
|
||||
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetMediaMetaDataRequest, request)
|
||||
headers['Accept'] = 'application/json'
|
||||
headers['user-agent'] = @sdk_configuration.user_agent
|
||||
|
||||
r = @sdk_configuration.client.get(url) do |req|
|
||||
req.headers = headers
|
||||
req.params = query_params
|
||||
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
||||
end
|
||||
|
||||
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
||||
|
||||
res = ::PlexRubySDK::Operations::GetMetaDataByRatingKeyResponse.new(
|
||||
res = ::PlexRubySDK::Operations::GetMediaMetaDataResponse.new(
|
||||
status_code: r.status, content_type: content_type, raw_response: r
|
||||
)
|
||||
if r.status == 200
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMetaDataByRatingKeyResponseBody)
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMediaMetaDataResponseBody)
|
||||
res.object = out
|
||||
end
|
||||
elsif r.status == 400
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMetaDataByRatingKeyBadRequest)
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMediaMetaDataBadRequest)
|
||||
res.bad_request = out
|
||||
end
|
||||
elsif r.status == 401
|
||||
if Utils.match_content_type(content_type, 'application/json')
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMetaDataByRatingKeyUnauthorized)
|
||||
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetMediaMetaDataUnauthorized)
|
||||
res.unauthorized = out
|
||||
end
|
||||
elsif r.status == 404
|
||||
end
|
||||
|
||||
res
|
||||
|
||||
@@ -448,6 +448,7 @@ module PlexRubySDK
|
||||
autoload :GetSearchLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_search_library_mediacontainer.rb'
|
||||
autoload :GetSearchLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_search_library_responsebody.rb'
|
||||
autoload :GetSearchLibraryResponse, 'plex_ruby_sdk/models/operations/get_search_library_response.rb'
|
||||
autoload :GetGenresLibraryQueryParamType, 'plex_ruby_sdk/models/operations/get_genres_library_queryparam_type.rb'
|
||||
autoload :GetGenresLibraryRequest, 'plex_ruby_sdk/models/operations/get_genres_library_request.rb'
|
||||
autoload :GetGenresLibraryLibraryErrors, 'plex_ruby_sdk/models/operations/get_genres_library_library_errors.rb'
|
||||
autoload :GetGenresLibraryUnauthorized, 'plex_ruby_sdk/models/operations/get_genres_library_unauthorized.rb'
|
||||
@@ -457,6 +458,7 @@ module PlexRubySDK
|
||||
autoload :GetGenresLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_genres_library_mediacontainer.rb'
|
||||
autoload :GetGenresLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_genres_library_responsebody.rb'
|
||||
autoload :GetGenresLibraryResponse, 'plex_ruby_sdk/models/operations/get_genres_library_response.rb'
|
||||
autoload :GetCountriesLibraryQueryParamType, 'plex_ruby_sdk/models/operations/get_countries_library_queryparam_type.rb'
|
||||
autoload :GetCountriesLibraryRequest, 'plex_ruby_sdk/models/operations/get_countries_library_request.rb'
|
||||
autoload :GetCountriesLibraryLibraryErrors, 'plex_ruby_sdk/models/operations/get_countries_library_library_errors.rb'
|
||||
autoload :GetCountriesLibraryUnauthorized, 'plex_ruby_sdk/models/operations/get_countries_library_unauthorized.rb'
|
||||
@@ -466,6 +468,16 @@ module PlexRubySDK
|
||||
autoload :GetCountriesLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_countries_library_mediacontainer.rb'
|
||||
autoload :GetCountriesLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_countries_library_responsebody.rb'
|
||||
autoload :GetCountriesLibraryResponse, 'plex_ruby_sdk/models/operations/get_countries_library_response.rb'
|
||||
autoload :GetActorsLibraryQueryParamType, 'plex_ruby_sdk/models/operations/get_actors_library_queryparam_type.rb'
|
||||
autoload :GetActorsLibraryRequest, 'plex_ruby_sdk/models/operations/get_actors_library_request.rb'
|
||||
autoload :GetActorsLibraryLibraryErrors, 'plex_ruby_sdk/models/operations/get_actors_library_library_errors.rb'
|
||||
autoload :GetActorsLibraryUnauthorized, 'plex_ruby_sdk/models/operations/get_actors_library_unauthorized.rb'
|
||||
autoload :GetActorsLibraryErrors, 'plex_ruby_sdk/models/operations/get_actors_library_errors.rb'
|
||||
autoload :GetActorsLibraryBadRequest, 'plex_ruby_sdk/models/operations/get_actors_library_badrequest.rb'
|
||||
autoload :GetActorsLibraryDirectory, 'plex_ruby_sdk/models/operations/get_actors_library_directory.rb'
|
||||
autoload :GetActorsLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_actors_library_mediacontainer.rb'
|
||||
autoload :GetActorsLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_actors_library_responsebody.rb'
|
||||
autoload :GetActorsLibraryResponse, 'plex_ruby_sdk/models/operations/get_actors_library_response.rb'
|
||||
autoload :SearchTypes, 'plex_ruby_sdk/models/operations/searchtypes.rb'
|
||||
autoload :QueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/queryparam_includecollections.rb'
|
||||
autoload :QueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/queryparam_includeexternalmedia.rb'
|
||||
@@ -501,26 +513,30 @@ module PlexRubySDK
|
||||
autoload :GetSearchAllLibrariesMediaContainer, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediacontainer.rb'
|
||||
autoload :GetSearchAllLibrariesResponseBody, 'plex_ruby_sdk/models/operations/get_search_all_libraries_responsebody.rb'
|
||||
autoload :GetSearchAllLibrariesResponse, 'plex_ruby_sdk/models/operations/get_search_all_libraries_response.rb'
|
||||
autoload :GetMetaDataByRatingKeyRequest, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_request.rb'
|
||||
autoload :GetMetaDataByRatingKeyLibraryErrors, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_library_errors.rb'
|
||||
autoload :GetMetaDataByRatingKeyUnauthorized, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_unauthorized.rb'
|
||||
autoload :GetMetaDataByRatingKeyErrors, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_errors.rb'
|
||||
autoload :GetMetaDataByRatingKeyBadRequest, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_badrequest.rb'
|
||||
autoload :GetMetaDataByRatingKeyStream, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_stream.rb'
|
||||
autoload :GetMetaDataByRatingKeyPart, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_part.rb'
|
||||
autoload :GetMetaDataByRatingKeyMedia, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_media.rb'
|
||||
autoload :GetMetaDataByRatingKeyGenre, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_genre.rb'
|
||||
autoload :GetMetaDataByRatingKeyCountry, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_country.rb'
|
||||
autoload :GetMediaMetaDataRequest, 'plex_ruby_sdk/models/operations/get_media_meta_data_request.rb'
|
||||
autoload :GetMediaMetaDataLibraryErrors, 'plex_ruby_sdk/models/operations/get_media_meta_data_library_errors.rb'
|
||||
autoload :GetMediaMetaDataUnauthorized, 'plex_ruby_sdk/models/operations/get_media_meta_data_unauthorized.rb'
|
||||
autoload :GetMediaMetaDataErrors, 'plex_ruby_sdk/models/operations/get_media_meta_data_errors.rb'
|
||||
autoload :GetMediaMetaDataBadRequest, 'plex_ruby_sdk/models/operations/get_media_meta_data_badrequest.rb'
|
||||
autoload :GetMediaMetaDataStream, 'plex_ruby_sdk/models/operations/get_media_meta_data_stream.rb'
|
||||
autoload :GetMediaMetaDataPart, 'plex_ruby_sdk/models/operations/get_media_meta_data_part.rb'
|
||||
autoload :GetMediaMetaDataMedia, 'plex_ruby_sdk/models/operations/get_media_meta_data_media.rb'
|
||||
autoload :GetMediaMetaDataImage, 'plex_ruby_sdk/models/operations/get_media_meta_data_image.rb'
|
||||
autoload :GetMediaMetaDataUltraBlurColors, 'plex_ruby_sdk/models/operations/get_media_meta_data_ultrablurcolors.rb'
|
||||
autoload :GetMediaMetaDataGenre, 'plex_ruby_sdk/models/operations/get_media_meta_data_genre.rb'
|
||||
autoload :GetMediaMetaDataCountry, 'plex_ruby_sdk/models/operations/get_media_meta_data_country.rb'
|
||||
autoload :Guids, 'plex_ruby_sdk/models/operations/guids.rb'
|
||||
autoload :Ratings, 'plex_ruby_sdk/models/operations/ratings.rb'
|
||||
autoload :GetMetaDataByRatingKeyDirector, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_director.rb'
|
||||
autoload :GetMetaDataByRatingKeyWriter, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_writer.rb'
|
||||
autoload :GetMetaDataByRatingKeyRole, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_role.rb'
|
||||
autoload :Rating, 'plex_ruby_sdk/models/operations/rating.rb'
|
||||
autoload :GetMediaMetaDataRole, 'plex_ruby_sdk/models/operations/get_media_meta_data_role.rb'
|
||||
autoload :GetMediaMetaDataDirector, 'plex_ruby_sdk/models/operations/get_media_meta_data_director.rb'
|
||||
autoload :GetMediaMetaDataWriter, 'plex_ruby_sdk/models/operations/get_media_meta_data_writer.rb'
|
||||
autoload :Producer, 'plex_ruby_sdk/models/operations/producer.rb'
|
||||
autoload :GetMetaDataByRatingKeyMetadata, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_metadata.rb'
|
||||
autoload :GetMetaDataByRatingKeyMediaContainer, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_mediacontainer.rb'
|
||||
autoload :GetMetaDataByRatingKeyResponseBody, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_responsebody.rb'
|
||||
autoload :GetMetaDataByRatingKeyResponse, 'plex_ruby_sdk/models/operations/get_meta_data_by_rating_key_response.rb'
|
||||
autoload :Similar, 'plex_ruby_sdk/models/operations/similar.rb'
|
||||
autoload :GetMediaMetaDataLocation, 'plex_ruby_sdk/models/operations/get_media_meta_data_location.rb'
|
||||
autoload :GetMediaMetaDataMetadata, 'plex_ruby_sdk/models/operations/get_media_meta_data_metadata.rb'
|
||||
autoload :GetMediaMetaDataMediaContainer, 'plex_ruby_sdk/models/operations/get_media_meta_data_mediacontainer.rb'
|
||||
autoload :GetMediaMetaDataResponseBody, 'plex_ruby_sdk/models/operations/get_media_meta_data_responsebody.rb'
|
||||
autoload :GetMediaMetaDataResponse, 'plex_ruby_sdk/models/operations/get_media_meta_data_response.rb'
|
||||
autoload :GetMetadataChildrenRequest, 'plex_ruby_sdk/models/operations/getmetadatachildren_request.rb'
|
||||
autoload :GetMetadataChildrenLibraryErrors, 'plex_ruby_sdk/models/operations/getmetadatachildren_library_errors.rb'
|
||||
autoload :GetMetadataChildrenUnauthorized, 'plex_ruby_sdk/models/operations/getmetadatachildren_unauthorized.rb'
|
||||
|
||||
@@ -8,14 +8,14 @@ module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
class GetMetaDataByRatingKeyBadRequest < ::PlexRubySDK::Utils::FieldAugmented
|
||||
class GetActorsLibraryBadRequest < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
|
||||
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
|
||||
|
||||
|
||||
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyErrors])).void }
|
||||
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryErrors])).void }
|
||||
def initialize(errors: nil)
|
||||
@errors = errors
|
||||
end
|
||||
@@ -0,0 +1,33 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetActorsLibraryDirectory < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# A fast lookup key for the actor relative url.
|
||||
field :fast_key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('fastKey') } }
|
||||
# A unique key representing the actor.
|
||||
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
|
||||
# URL for the thumbnail image of the actor.
|
||||
field :thumb, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } }
|
||||
# The name of the actor.
|
||||
field :title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title') } }
|
||||
|
||||
|
||||
sig { params(fast_key: ::String, key: ::String, thumb: ::String, title: ::String).void }
|
||||
def initialize(fast_key: nil, key: nil, thumb: nil, title: nil)
|
||||
@fast_key = fast_key
|
||||
@key = key
|
||||
@thumb = thumb
|
||||
@title = title
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,7 +8,7 @@ module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
class GetActorsLibraryErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMetaDataByRatingKeyLibraryErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
class GetActorsLibraryLibraryErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetActorsLibraryMediaContainer < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# Indicates whether syncing is allowed.
|
||||
field :allow_sync, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('allowSync') } }
|
||||
# URL for the background artwork of the media container.
|
||||
field :art, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('art') } }
|
||||
# An plugin identifier for the media container.
|
||||
field :identifier, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('identifier') } }
|
||||
# The prefix used for media tag resource paths.
|
||||
field :media_tag_prefix, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagPrefix') } }
|
||||
# The version number for media tags.
|
||||
field :media_tag_version, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagVersion') } }
|
||||
# Specifies whether caching is disabled.
|
||||
field :nocache, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('nocache') } }
|
||||
|
||||
field :size, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
|
||||
# URL for the thumbnail image of the media container.
|
||||
field :thumb, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } }
|
||||
# The primary title of the media container.
|
||||
field :title1, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title1') } }
|
||||
# The secondary title of the media container.
|
||||
field :title2, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title2') } }
|
||||
# Identifier for the view group layout.
|
||||
field :view_group, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewGroup') } }
|
||||
# Identifier for the view mode.
|
||||
field :view_mode, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewMode') } }
|
||||
# An array of actor entries for media items.
|
||||
field :directory, T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryDirectory]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Directory') } }
|
||||
|
||||
|
||||
sig { params(allow_sync: T::Boolean, art: ::String, identifier: ::String, media_tag_prefix: ::String, media_tag_version: ::Integer, nocache: T::Boolean, size: ::Float, thumb: ::String, title1: ::String, title2: ::String, view_group: ::String, view_mode: ::String, directory: T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryDirectory])).void }
|
||||
def initialize(allow_sync: nil, art: nil, identifier: nil, media_tag_prefix: nil, media_tag_version: nil, nocache: nil, size: nil, thumb: nil, title1: nil, title2: nil, view_group: nil, view_mode: nil, directory: nil)
|
||||
@allow_sync = allow_sync
|
||||
@art = art
|
||||
@identifier = identifier
|
||||
@media_tag_prefix = media_tag_prefix
|
||||
@media_tag_version = media_tag_version
|
||||
@nocache = nocache
|
||||
@size = size
|
||||
@thumb = thumb
|
||||
@title1 = title1
|
||||
@title2 = title2
|
||||
@view_group = view_group
|
||||
@view_mode = view_mode
|
||||
@directory = directory
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,29 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# GetActorsLibraryQueryParamType - The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
class GetActorsLibraryQueryParamType < T::Enum
|
||||
enums do
|
||||
MOVIE = new(1)
|
||||
TV_SHOW = new(2)
|
||||
SEASON = new(3)
|
||||
EPISODE = new(4)
|
||||
AUDIO = new(8)
|
||||
ALBUM = new(9)
|
||||
TRACK = new(10)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,35 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetActorsLibraryRequest < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The unique key of the Plex library.
|
||||
# Note: This is unique in the context of the Plex server.
|
||||
#
|
||||
field :section_key, ::Integer, { 'path_param': { 'field_name': 'sectionKey', 'style': 'simple', 'explode': false } }
|
||||
# The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
field :type, ::PlexRubySDK::Operations::GetActorsLibraryQueryParamType, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetActorsLibraryQueryParamType).void }
|
||||
def initialize(section_key: nil, type: nil)
|
||||
@section_key = section_key
|
||||
@type = type
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetActorsLibraryResponse < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# HTTP response content type for this operation
|
||||
field :content_type, ::String
|
||||
# Raw HTTP response; suitable for custom response parsing
|
||||
field :raw_response, ::Faraday::Response
|
||||
# HTTP response status code for this operation
|
||||
field :status_code, ::Integer
|
||||
# Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
field :bad_request, T.nilable(::PlexRubySDK::Operations::GetActorsLibraryBadRequest)
|
||||
# Successful response containing media container data.
|
||||
field :object, T.nilable(::PlexRubySDK::Operations::GetActorsLibraryResponseBody)
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
field :unauthorized, T.nilable(::PlexRubySDK::Operations::GetActorsLibraryUnauthorized)
|
||||
|
||||
|
||||
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::PlexRubySDK::Operations::GetActorsLibraryBadRequest), object: T.nilable(::PlexRubySDK::Operations::GetActorsLibraryResponseBody), unauthorized: T.nilable(::PlexRubySDK::Operations::GetActorsLibraryUnauthorized)).void }
|
||||
def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, object: nil, unauthorized: nil)
|
||||
@content_type = content_type
|
||||
@raw_response = raw_response
|
||||
@status_code = status_code
|
||||
@bad_request = bad_request
|
||||
@object = object
|
||||
@unauthorized = unauthorized
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# Successful response containing media container data.
|
||||
class GetActorsLibraryResponseBody < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :media_container, T.nilable(::PlexRubySDK::Operations::GetActorsLibraryMediaContainer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('MediaContainer') } }
|
||||
|
||||
|
||||
sig { params(media_container: T.nilable(::PlexRubySDK::Operations::GetActorsLibraryMediaContainer)).void }
|
||||
def initialize(media_container: nil)
|
||||
@media_container = media_container
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,14 +8,14 @@ module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
class GetMetaDataByRatingKeyUnauthorized < ::PlexRubySDK::Utils::FieldAugmented
|
||||
class GetActorsLibraryUnauthorized < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyLibraryErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
|
||||
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryLibraryErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
|
||||
|
||||
|
||||
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetMetaDataByRatingKeyLibraryErrors])).void }
|
||||
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryLibraryErrors])).void }
|
||||
def initialize(errors: nil)
|
||||
@errors = errors
|
||||
end
|
||||
@@ -0,0 +1,29 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# GetCountriesLibraryQueryParamType - The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
class GetCountriesLibraryQueryParamType < T::Enum
|
||||
enums do
|
||||
MOVIE = new(1)
|
||||
TV_SHOW = new(2)
|
||||
SEASON = new(3)
|
||||
EPISODE = new(4)
|
||||
AUDIO = new(8)
|
||||
ALBUM = new(9)
|
||||
TRACK = new(10)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -15,11 +15,20 @@ module PlexRubySDK
|
||||
# Note: This is unique in the context of the Plex server.
|
||||
#
|
||||
field :section_key, ::Integer, { 'path_param': { 'field_name': 'sectionKey', 'style': 'simple', 'explode': false } }
|
||||
# The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
field :type, ::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer).void }
|
||||
def initialize(section_key: nil)
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType).void }
|
||||
def initialize(section_key: nil, type: nil)
|
||||
@section_key = section_key
|
||||
@type = type
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# GetGenresLibraryQueryParamType - The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
class GetGenresLibraryQueryParamType < T::Enum
|
||||
enums do
|
||||
MOVIE = new(1)
|
||||
TV_SHOW = new(2)
|
||||
SEASON = new(3)
|
||||
EPISODE = new(4)
|
||||
AUDIO = new(8)
|
||||
ALBUM = new(9)
|
||||
TRACK = new(10)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -15,11 +15,20 @@ module PlexRubySDK
|
||||
# Note: This is unique in the context of the Plex server.
|
||||
#
|
||||
field :section_key, ::Integer, { 'path_param': { 'field_name': 'sectionKey', 'style': 'simple', 'explode': false } }
|
||||
# The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
field :type, ::PlexRubySDK::Operations::GetGenresLibraryQueryParamType, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer).void }
|
||||
def initialize(section_key: nil)
|
||||
sig { params(section_key: ::Integer, type: ::PlexRubySDK::Operations::GetGenresLibraryQueryParamType).void }
|
||||
def initialize(section_key: nil, type: nil)
|
||||
@section_key = section_key
|
||||
@type = type
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# GetLibraryItemsQueryParamType - The type of media to retrieve.
|
||||
# GetLibraryItemsQueryParamType - The type of media to retrieve or filter by.
|
||||
# 1 = movie
|
||||
# 2 = show
|
||||
# 3 = season
|
||||
|
||||
@@ -17,20 +17,20 @@ module PlexRubySDK
|
||||
field :section_key, ::Integer, { 'path_param': { 'field_name': 'sectionKey', 'style': 'simple', 'explode': false } }
|
||||
# A key representing a specific tag within the section.
|
||||
field :tag, ::PlexRubySDK::Operations::Tag, { 'path_param': { 'field_name': 'tag', 'style': 'simple', 'explode': false } }
|
||||
# Adds the Guids object to the response
|
||||
#
|
||||
field :include_guids, T.nilable(::PlexRubySDK::Operations::IncludeGuids), { 'query_param': { 'field_name': 'includeGuids', 'style': 'form', 'explode': true } }
|
||||
# Adds the Meta object to the response
|
||||
#
|
||||
field :include_meta, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta), { 'query_param': { 'field_name': 'includeMeta', 'style': 'form', 'explode': true } }
|
||||
# The type of media to retrieve.
|
||||
# The type of media to retrieve or filter by.
|
||||
# 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
|
||||
#
|
||||
field :type, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamType), { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
field :type, ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
||||
# Adds the Guids object to the response
|
||||
#
|
||||
field :include_guids, T.nilable(::PlexRubySDK::Operations::IncludeGuids), { 'query_param': { 'field_name': 'includeGuids', 'style': 'form', 'explode': true } }
|
||||
# Adds the Meta object to the response
|
||||
#
|
||||
field :include_meta, T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta), { 'query_param': { 'field_name': 'includeMeta', 'style': 'form', 'explode': true } }
|
||||
# The number of items to return. If not specified, all items will be returned.
|
||||
# If the number of items exceeds the limit, the response will be paginated.
|
||||
# By default this is 50
|
||||
@@ -43,13 +43,13 @@ module PlexRubySDK
|
||||
field :x_plex_container_start, T.nilable(::Integer), { 'query_param': { 'field_name': 'X-Plex-Container-Start', 'style': 'form', 'explode': true } }
|
||||
|
||||
|
||||
sig { params(section_key: ::Integer, tag: ::PlexRubySDK::Operations::Tag, include_guids: T.nilable(::PlexRubySDK::Operations::IncludeGuids), include_meta: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta), type: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamType), x_plex_container_size: T.nilable(::Integer), x_plex_container_start: T.nilable(::Integer)).void }
|
||||
def initialize(section_key: nil, tag: nil, include_guids: nil, include_meta: nil, type: nil, x_plex_container_size: nil, x_plex_container_start: nil)
|
||||
sig { params(section_key: ::Integer, tag: ::PlexRubySDK::Operations::Tag, type: ::PlexRubySDK::Operations::GetLibraryItemsQueryParamType, include_guids: T.nilable(::PlexRubySDK::Operations::IncludeGuids), include_meta: T.nilable(::PlexRubySDK::Operations::GetLibraryItemsQueryParamIncludeMeta), x_plex_container_size: T.nilable(::Integer), x_plex_container_start: T.nilable(::Integer)).void }
|
||||
def initialize(section_key: nil, tag: nil, type: nil, include_guids: nil, include_meta: nil, x_plex_container_size: nil, x_plex_container_start: nil)
|
||||
@section_key = section_key
|
||||
@tag = tag
|
||||
@type = type
|
||||
@include_guids = include_guids
|
||||
@include_meta = include_meta
|
||||
@type = type
|
||||
@x_plex_container_size = x_plex_container_size
|
||||
@x_plex_container_start = x_plex_container_start
|
||||
end
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
# Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
class GetMediaMetaDataBadRequest < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetMediaMetaDataErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
|
||||
|
||||
|
||||
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetMediaMetaDataErrors])).void }
|
||||
def initialize(errors: nil)
|
||||
@errors = errors
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataCountry < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The filter string for the country.
|
||||
field :filter, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('filter') } }
|
||||
# The unique country identifier.
|
||||
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
|
||||
# The country name.
|
||||
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
|
||||
|
||||
|
||||
sig { params(filter: ::String, id: ::Integer, tag: ::String).void }
|
||||
def initialize(filter: nil, id: nil, tag: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@tag = tag
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,39 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataDirector < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The filter string for the role.
|
||||
field :filter, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('filter') } }
|
||||
# The unique role identifier.
|
||||
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
|
||||
# The actor's name.
|
||||
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
|
||||
# A key associated with the actor tag.
|
||||
field :tag_key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tagKey') } }
|
||||
# The character name or role.
|
||||
field :role, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('role') } }
|
||||
# URL for the role thumbnail image.
|
||||
field :thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } }
|
||||
|
||||
|
||||
sig { params(filter: ::String, id: ::Integer, tag: ::String, tag_key: ::String, role: T.nilable(::String), thumb: T.nilable(::String)).void }
|
||||
def initialize(filter: nil, id: nil, tag: nil, tag_key: nil, role: nil, thumb: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@tag = tag
|
||||
@tag_key = tag_key
|
||||
@role = role
|
||||
@thumb = thumb
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :code, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('code') } }
|
||||
|
||||
field :message, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('message') } }
|
||||
|
||||
field :status, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('status') } }
|
||||
|
||||
|
||||
sig { params(code: T.nilable(::Integer), message: T.nilable(::String), status: T.nilable(::Integer)).void }
|
||||
def initialize(code: nil, message: nil, status: nil)
|
||||
@code = code
|
||||
@message = message
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataGenre < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The filter string for the genre.
|
||||
field :filter, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('filter') } }
|
||||
# The unique genre identifier.
|
||||
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
|
||||
# The genre name.
|
||||
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
|
||||
|
||||
|
||||
sig { params(filter: ::String, id: ::Integer, tag: ::String).void }
|
||||
def initialize(filter: nil, id: nil, tag: nil)
|
||||
@filter = filter
|
||||
@id = id
|
||||
@tag = tag
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataImage < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# Alternate text for the image.
|
||||
field :alt, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('alt') } }
|
||||
# The type of image (e.g., coverPoster, background, clearLogo).
|
||||
field :type, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type') } }
|
||||
# The URL of the image.
|
||||
field :url, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('url') } }
|
||||
|
||||
|
||||
sig { params(alt: ::String, type: ::String, url: ::String).void }
|
||||
def initialize(alt: nil, type: nil, url: nil)
|
||||
@alt = alt
|
||||
@type = type
|
||||
@url = url
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,30 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataLibraryErrors < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
|
||||
field :code, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('code') } }
|
||||
|
||||
field :message, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('message') } }
|
||||
|
||||
field :status, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('status') } }
|
||||
|
||||
|
||||
sig { params(code: T.nilable(::Integer), message: T.nilable(::String), status: T.nilable(::Integer)).void }
|
||||
def initialize(code: nil, message: nil, status: nil)
|
||||
@code = code
|
||||
@message = message
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataLocation < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# The file path for the location.
|
||||
field :path, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('path') } }
|
||||
|
||||
|
||||
sig { params(path: ::String).void }
|
||||
def initialize(path: nil)
|
||||
@path = path
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,66 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataMedia < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# Aspect ratio of the video.
|
||||
field :aspect_ratio, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('aspectRatio') } }
|
||||
# Number of audio channels.
|
||||
field :audio_channels, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioChannels') } }
|
||||
# Audio codec used.
|
||||
field :audio_codec, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioCodec') } }
|
||||
# Bitrate in bits per second.
|
||||
field :bitrate, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('bitrate') } }
|
||||
# File container type.
|
||||
field :container, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
|
||||
# Duration of the media in milliseconds.
|
||||
field :duration, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
|
||||
# Indicates whether voice activity is detected.
|
||||
field :has_voice_activity, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasVoiceActivity') } }
|
||||
# Video height in pixels.
|
||||
field :height, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('height') } }
|
||||
# Unique media identifier.
|
||||
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
|
||||
# An array of parts for this media item.
|
||||
field :part, T::Array[::PlexRubySDK::Operations::GetMediaMetaDataPart], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Part') } }
|
||||
# Video codec used.
|
||||
field :video_codec, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoCodec') } }
|
||||
# Frame rate of the video (e.g., 24p).
|
||||
field :video_frame_rate, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoFrameRate') } }
|
||||
# Video profile (e.g., main 10).
|
||||
field :video_profile, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
|
||||
# Video resolution (e.g., 4k).
|
||||
field :video_resolution, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoResolution') } }
|
||||
# Video width in pixels.
|
||||
field :width, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('width') } }
|
||||
|
||||
|
||||
sig { params(aspect_ratio: ::Float, audio_channels: ::Integer, audio_codec: ::String, bitrate: ::Integer, container: ::String, duration: ::Integer, has_voice_activity: T::Boolean, height: ::Integer, id: ::Integer, part: T::Array[::PlexRubySDK::Operations::GetMediaMetaDataPart], video_codec: ::String, video_frame_rate: ::String, video_profile: ::String, video_resolution: ::String, width: ::Integer).void }
|
||||
def initialize(aspect_ratio: nil, audio_channels: nil, audio_codec: nil, bitrate: nil, container: nil, duration: nil, has_voice_activity: nil, height: nil, id: nil, part: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil)
|
||||
@aspect_ratio = aspect_ratio
|
||||
@audio_channels = audio_channels
|
||||
@audio_codec = audio_codec
|
||||
@bitrate = bitrate
|
||||
@container = container
|
||||
@duration = duration
|
||||
@has_voice_activity = has_voice_activity
|
||||
@height = height
|
||||
@id = id
|
||||
@part = part
|
||||
@video_codec = video_codec
|
||||
@video_frame_rate = video_frame_rate
|
||||
@video_profile = video_profile
|
||||
@video_resolution = video_resolution
|
||||
@width = width
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,48 @@
|
||||
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
|
||||
# typed: true
|
||||
# frozen_string_literal: true
|
||||
|
||||
|
||||
module PlexRubySDK
|
||||
module Operations
|
||||
|
||||
|
||||
class GetMediaMetaDataMediaContainer < ::PlexRubySDK::Utils::FieldAugmented
|
||||
extend T::Sig
|
||||
|
||||
# Indicates whether syncing is allowed.
|
||||
field :allow_sync, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('allowSync') } }
|
||||
# An plugin identifier for the media container.
|
||||
field :identifier, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('identifier') } }
|
||||
# The unique identifier for the library section.
|
||||
field :library_section_id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionID') } }
|
||||
# The title of the library section.
|
||||
field :library_section_title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionTitle') } }
|
||||
# The prefix used for media tag resource paths.
|
||||
field :media_tag_prefix, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagPrefix') } }
|
||||
# The version number for media tags.
|
||||
field :media_tag_version, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagVersion') } }
|
||||
# An array of metadata items.
|
||||
field :metadata, T::Array[::PlexRubySDK::Operations::GetMediaMetaDataMetadata], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Metadata') } }
|
||||
|
||||
field :size, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
|
||||
# The universally unique identifier for the library section.
|
||||
field :library_section_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionUUID') } }
|
||||
|
||||
|
||||
sig { params(allow_sync: T::Boolean, identifier: ::String, library_section_id: ::Integer, library_section_title: ::String, media_tag_prefix: ::String, media_tag_version: ::Integer, metadata: T::Array[::PlexRubySDK::Operations::GetMediaMetaDataMetadata], size: ::Float, library_section_uuid: T.nilable(::String)).void }
|
||||
def initialize(allow_sync: nil, identifier: nil, library_section_id: nil, library_section_title: nil, media_tag_prefix: nil, media_tag_version: nil, metadata: nil, size: nil, library_section_uuid: nil)
|
||||
@allow_sync = allow_sync
|
||||
@identifier = identifier
|
||||
@library_section_id = library_section_id
|
||||
@library_section_title = library_section_title
|
||||
@media_tag_prefix = media_tag_prefix
|
||||
@media_tag_version = media_tag_version
|
||||
@metadata = metadata
|
||||
@size = size
|
||||
@library_section_uuid = library_section_uuid
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user