ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.488.0

This commit is contained in:
speakeasybot
2025-02-11 00:09:18 +00:00
parent 18f383117a
commit 70e432702d
140 changed files with 2733 additions and 268 deletions

File diff suppressed because one or more lines are too long

View File

@@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
ruby: ruby:
version: 0.7.4 version: 0.7.5
author: LukeHagar author: LukeHagar
description: Ruby Client SDK Generated by Speakeasy description: Ruby Client SDK Generated by Speakeasy
imports: imports:

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.487.1 speakeasyVersion: 1.488.0
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64 sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8 sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1738973265 - speakeasy-sdk-regen-1739232482
targets: targets:
plexruby: plexruby:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64 sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8 sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
codeSamplesNamespace: code-samples-ruby-plexruby codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:eac592b001aa961d7be4bd82b03336ae654e260261abc5548faf1b199b6eea16 codeSamplesRevisionDigest: sha256:21075555343fdaee57b8bcb81c1dc0b14ba00606b2fc9fc27e4a95c7a6ad3c80
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

View File

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

View File

@@ -131,6 +131,7 @@ end
* [get_library_details](docs/sdks/library/README.md#get_library_details) - Get Library Details * [get_library_details](docs/sdks/library/README.md#get_library_details) - Get Library Details
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section * [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items * [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
* [get_all_media_library](docs/sdks/library/README.md#get_all_media_library) - Get all media of library
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library * [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library * [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_genres_library](docs/sdks/library/README.md#get_genres_library) - Get Genres of library media

View File

@@ -716,4 +716,14 @@ Based on:
### Generated ### Generated
- [ruby v0.7.4] . - [ruby v0.7.4] .
### Releases ### Releases
- [Ruby Gems v0.7.4] https://rubygems.org/gems/plex_ruby_sdk/versions/0.7.4 - . - [Ruby Gems v0.7.4] https://rubygems.org/gems/plex_ruby_sdk/versions/0.7.4 - .
## 2025-02-11 00:07:47
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.488.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.7.5] .
### Releases
- [Ruby Gems v0.7.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.7.5 - .

View File

@@ -206,7 +206,7 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: libraries label: libraries
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::GetSearchAllLibrariesRequest.new(\n query: \"<value>\",\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n search_types: [\n ::PlexRubySDK::Operations::SearchTypes::PEOPLE,\n ],\n include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,\n include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,\n)\n \nres = s.library.get_search_all_libraries(req)\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\nreq = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(\n query: \"<value>\",\n client_id: \"3381b62b-9ab7-4e37-827b-203e9809eb58\",\n search_types: [\n ::PlexRubySDK::Operations::SearchTypes::PEOPLE,\n ],\n include_collections: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeCollections::ENABLE,\n include_external_media: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeExternalMedia::ENABLE,\n)\n \nres = s.library.get_search_all_libraries(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"] - target: $["paths"]["/library/sections"]["get"]
update: update:
x-codeSamples: x-codeSamples:
@@ -237,6 +237,12 @@ actions:
- lang: ruby - lang: ruby
label: library 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" 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}/all"]["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\nreq = ::PlexRubySDK::Operations::GetAllMediaLibraryRequest.new(\n section_key: 9518,\n type: ::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamType::TV_SHOW,\n include_meta: ::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamIncludeMeta::ENABLE,\n include_guids: ::PlexRubySDK::Operations::QueryParamIncludeGuids::ENABLE,\n include_advanced: ::PlexRubySDK::Operations::IncludeAdvanced::ENABLE,\n include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,\n include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_all_media_library(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
update: update:
x-codeSamples: x-codeSamples:

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false | | `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 | | `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 | | `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCollection
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *::String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCountry
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *::String* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

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

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryDirector
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *::String* | :heavy_check_mark: | The role of Director | Danny Boyle |

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,13 @@
# GetAllMediaLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter` | *::String* | :heavy_check_mark: | N/A | genre |
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `advanced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryGenre
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *::String* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,16 @@
# GetAllMediaLibraryLibraryType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | File container type. | mkv |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T::Boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimized_for_streaming` | *T.nilable(::Object)* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md)> | :heavy_check_mark: | An array of parts for this media item. | |

View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `total_size` | *::Integer* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `offset` | *::Integer* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `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 |
| `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary |
| `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 |
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `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 |
| `meta` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryMeta)](../../models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryMetadata](../../models/operations/getallmedialibrarymetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

View File

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

View File

@@ -0,0 +1,74 @@
# GetAllMediaLibraryMetadata
Unknown
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `key` | *::String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *::String* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `type` | [::PlexRubySDK::Operations::GetAllMediaLibraryLibraryType](../../models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `title_sort` | *::String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `summary` | *::String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *::Float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *::Integer* | :heavy_check_mark: | The release year of the media item. | 2022 |
| `tagline` | *::String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *::String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *::String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `theme` | *::String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `index` | *::Integer* | :heavy_check_mark: | The index position of the media item. | 1 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `child_count` | *::Integer* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `season_count` | *::Integer* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *::Integer* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `last_rated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `created_at_accuracy` | *T.nilable(::String)* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `created_at_tz_offset` | *T.nilable(::String)* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `user_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `image` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryImage](../../models/operations/getallmedialibraryimage.md)> | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryUltraBlurColors)](../../models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `media` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryMedia](../../models/operations/getallmedialibrarymedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryGenre](../../models/operations/getallmedialibrarygenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryCountry](../../models/operations/getallmedialibrarycountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryDirector](../../models/operations/getallmedialibrarydirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryWriter](../../models/operations/getallmedialibrarywriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryRole](../../models/operations/getallmedialibraryrole.md)> | :heavy_minus_sign: | N/A | |
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryCollection](../../models/operations/getallmedialibrarycollection.md)> | :heavy_minus_sign: | N/A | |

View File

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

View File

@@ -0,0 +1,23 @@
# GetAllMediaLibraryPart
## 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` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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 |
| `packet_length` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 188 |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the part. | mkv |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(::Object)* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryHasThumbnail)](../../models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryStream](../../models/operations/getallmedialibrarystream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

View File

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

View File

@@ -0,0 +1,22 @@
# GetAllMediaLibraryQueryParamType
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 |

View File

@@ -0,0 +1,16 @@
# GetAllMediaLibraryRequest
## 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::GetAllMediaLibraryQueryParamType](../../models/operations/getallmedialibraryqueryparamtype.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::GetAllMediaLibraryQueryParamIncludeMeta)](../../models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `include_guids` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeGuids)](../../models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `include_advanced` | [T.nilable(::PlexRubySDK::Operations::IncludeAdvanced)](../../models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
| `include_collections` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections)](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
| `include_external_media` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia)](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 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 |

View File

@@ -0,0 +1,13 @@
# GetAllMediaLibraryResponse
## 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::GetAllMediaLibraryResponseBody)](../../models/operations/getallmedialibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryBadRequest)](../../models/operations/getallmedialibrarybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryUnauthorized)](../../models/operations/getallmedialibraryunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

View File

@@ -0,0 +1,10 @@
# GetAllMediaLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryMediaContainer)](../../models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `tag` | *::String* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |

View File

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

View File

@@ -0,0 +1,54 @@
# GetAllMediaLibraryStream
## 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` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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 |
| `header_compression` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `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 |

View File

@@ -0,0 +1,15 @@
# GetAllMediaLibraryType
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | clip |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryFilter](../../models/operations/getallmedialibraryfilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibrarySort](../../models/operations/getallmedialibrarysort.md)> | :heavy_minus_sign: | N/A | |
| `field` | T::Array<[::PlexRubySDK::Operations::GetAllMediaLibraryField](../../models/operations/getallmedialibraryfield.md)> | :heavy_minus_sign: | N/A | |

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *::String* | :heavy_check_mark: | The role of Writer | Danny Boyle |

View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `art` | *::String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg | | `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `content` | *::String* | :heavy_check_mark: | N/A | secondary | | `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `media_tag_prefix` | *::String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ | | `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `media_tag_version` | *::Integer* | :heavy_check_mark: | N/A | 1734362201 | | `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/show.png | | `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `title1` | *::String* | :heavy_check_mark: | N/A | TV Series | | `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `title2` | *::String* | :heavy_check_mark: | N/A | By Country |
| `view_group` | *::String* | :heavy_check_mark: | N/A | secondary |
| `directory` | T::Array<[::PlexRubySDK::Operations::GetCountriesLibraryDirectory](../../models/operations/getcountrieslibrarydirectory.md)> | :heavy_minus_sign: | N/A | | | `directory` | T::Array<[::PlexRubySDK::Operations::GetCountriesLibraryDirectory](../../models/operations/getcountrieslibrarydirectory.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `art` | *::String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg | | `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `content` | *::String* | :heavy_check_mark: | N/A | secondary | | `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `media_tag_prefix` | *::String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ | | `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `media_tag_version` | *::Integer* | :heavy_check_mark: | N/A | 1734362201 | | `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `nocache` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/show.png | | `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `title1` | *::String* | :heavy_check_mark: | N/A | TV Shows (Reality) | | `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `title2` | *::String* | :heavy_check_mark: | N/A | By Genre |
| `view_group` | *::String* | :heavy_check_mark: | N/A | secondary |
| `directory` | T::Array<[::PlexRubySDK::Operations::GetGenresLibraryDirectory](../../models/operations/getgenreslibrarydirectory.md)> | :heavy_minus_sign: | N/A | | | `directory` | T::Array<[::PlexRubySDK::Operations::GetGenresLibraryDirectory](../../models/operations/getgenreslibrarydirectory.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -9,4 +9,5 @@
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string | | `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre | | `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `advanced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |

View File

@@ -11,4 +11,6 @@ The type of media content
| `MOVIE` | movie | | `MOVIE` | movie |
| `TV_SHOW` | show | | `TV_SHOW` | show |
| `SEASON` | season | | `SEASON` | season |
| `EPISODE` | episode | | `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | clip |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,8 @@
# GetMediaMetaDataGuids
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *::String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |

View File

@@ -0,0 +1,11 @@
# GetMediaMetaDataHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |

View File

@@ -6,17 +6,21 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 | | `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate in bits per second. | 25512 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *::Integer* | :heavy_check_mark: | Video width in pixels. | 3840 | | `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *::Integer* | :heavy_check_mark: | Video height in pixels. | 1602 | | `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *::Float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 | | `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_channels` | *::Integer* | :heavy_check_mark: | Number of audio channels. | 6 | | `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `audio_codec` | *::String* | :heavy_check_mark: | Audio codec used. | eac3 | | `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 |
| `video_codec` | *::String* | :heavy_check_mark: | Video codec used. | hevc | | `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `video_resolution` | *::String* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k | | `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Video codec used. | hevc |
| `container` | *::String* | :heavy_check_mark: | File container type. | mkv | | `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `video_frame_rate` | *::String* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | File container type. | mkv |
| `video_profile` | *::String* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 | | `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T::Boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false | | `has_voice_activity` | *T::Boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimized_for_streaming` | *T.nilable(::Object)* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_check_mark: | An array of parts for this media item. | | | `part` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_check_mark: | An array of parts for this media item. | |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false | | `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 | | `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_id` | *::Integer* | :heavy_check_mark: | The unique identifier for the library section. | 2 |

View File

@@ -23,16 +23,18 @@
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series | | `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_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 | | `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 | | `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | `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 | | `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 | | `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 | | `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 | | `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | 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 | | `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 | | `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 | | `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 | | `year` | *::Integer* | :heavy_check_mark: | The release year. | 2015 |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | The general rating | 6 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | The tagline of the content. | Make the call | | `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 | | `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 | | `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
@@ -40,13 +42,13 @@
| `art` | *::String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/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 | | `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 | | `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 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 | | `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 | | `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 | | `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 | | `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 | | `updated_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `audience_rating_image` | *::String* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating | | `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | 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_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 | | `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_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
@@ -56,8 +58,8 @@
| `ultra_blur_colors` | [::PlexRubySDK::Operations::GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | | | `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. | | | `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. | | | `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. | | | `guids` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)> | :heavy_minus_sign: | An array of GUID objects. | |
| `rating` | T::Array<[::PlexRubySDK::Operations::Rating](../../models/operations/rating.md)> | :heavy_check_mark: | An array of rating objects. | | | `ratings` | T::Array<[::PlexRubySDK::Operations::Ratings](../../models/operations/ratings.md)> | :heavy_minus_sign: | An array of rating objects. | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | An array of Actor roles. | | | `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. | | | `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. | | | `writer` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |

View File

@@ -3,16 +3,21 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `accessible` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part is accessible. | true | | `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 | | `exists` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *::Integer* | :heavy_check_mark: | Unique part identifier. | 418385 | | `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 | | `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 | | `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *::String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv | | `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 | | `size` | *::Integer* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `container` | *::String* | :heavy_check_mark: | Container format of the part. | mkv | | `packet_length` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 188 |
| `video_profile` | *::String* | :heavy_check_mark: | Video profile for the part. | main 10 | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the part. | mkv |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_check_mark: | An array of streams for this part. | | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(::Object)* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataHasThumbnail)](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

View File

@@ -10,10 +10,11 @@
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this stream is default. | true | | `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 | | `codec` | *::String* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *::Integer* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *::Integer* | :heavy_check_mark: | Index of the stream. | 0 |
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate of the stream. | 24743 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *::String* | :heavy_check_mark: | Language of the stream. | English | | `language` | *::String* | :heavy_check_mark: | Language of the stream. | English |
| `language_tag` | *::String* | :heavy_check_mark: | Language tag (e.g., en). | en | | `language_tag` | *::String* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `language_code` | *::String* | :heavy_check_mark: | ISO language code. | eng | | `language_code` | *::String* | :heavy_check_mark: | ISO language code. | eng |
| `header_compression` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `dovibl_compat_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `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 | | `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 | | `doviel_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |

View File

@@ -9,4 +9,5 @@
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string | | `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre | | `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `advanced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |

View File

@@ -11,4 +11,6 @@ The type of media content
| `MOVIE` | movie | | `MOVIE` | movie |
| `TV_SHOW` | show | | `TV_SHOW` | show |
| `SEASON` | season | | `SEASON` | season |
| `EPISODE` | episode | | `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

View File

@@ -9,4 +9,5 @@
| `filter_type` | *::String* | :heavy_check_mark: | N/A | string | | `filter_type` | *::String* | :heavy_check_mark: | N/A | string |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *::String* | :heavy_check_mark: | N/A | Genre | | `title` | *::String* | :heavy_check_mark: | N/A | Genre |
| `type` | *::String* | :heavy_check_mark: | N/A | filter | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `advanced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |

View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | clip |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 | | `size` | *::Integer* | :heavy_check_mark: | N/A | 50 |
| `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | | | `total_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library | | `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |

View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | show | | `type` | *::String* | :heavy_check_mark: | N/A | filter |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | clip |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | T::Array<[::PlexRubySDK::Operations::GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -3,11 +3,11 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | *::String* | :heavy_check_mark: | The search query term. | | | `query` | *::String* | :heavy_check_mark: | The search query term. | |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | | `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `limit` | *T.nilable(::Integer)* | :heavy_minus_sign: | Limit the number of results returned. | | | `limit` | *T.nilable(::Integer)* | :heavy_minus_sign: | Limit the number of results returned. | |
| `search_types` | T::Array<[::PlexRubySDK::Operations::SearchTypes](../../models/operations/searchtypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv | | `search_types` | T::Array<[::PlexRubySDK::Operations::SearchTypes](../../models/operations/searchtypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `include_collections` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections)](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 | | `include_collections` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeCollections)](../../models/operations/getsearchalllibrariesqueryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `include_external_media` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia)](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 | | `include_external_media` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeExternalMedia)](../../models/operations/getsearchalllibrariesqueryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

View File

@@ -11,4 +11,6 @@ The type of media content
| `MOVIE` | movie | | `MOVIE` | movie |
| `TV_SHOW` | show | | `TV_SHOW` | show |
| `SEASON` | season | | `SEASON` | season |
| `EPISODE` | episode | | `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

View File

@@ -3,6 +3,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *::String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 | | `id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

View File

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

View File

@@ -1,7 +1,5 @@
# QueryParamIncludeCollections # QueryParamIncludeCollections
Whether to include collections in the search results.
## Values ## Values

View File

@@ -1,7 +1,5 @@
# QueryParamIncludeExternalMedia # QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values ## Values

View File

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

View File

@@ -1,4 +1,4 @@
# Rating # Ratings
## Fields ## Fields

View File

@@ -7,7 +7,6 @@ A key representing a specific tag within the section.
| Name | Value | | Name | Value |
| ----------------- | ----------------- | | ----------------- | ----------------- |
| `ALL` | all |
| `UNWATCHED` | unwatched | | `UNWATCHED` | unwatched |
| `NEWEST` | newest | | `NEWEST` | newest |
| `RECENTLY_ADDED` | recentlyAdded | | `RECENTLY_ADDED` | recentlyAdded |
@@ -15,12 +14,9 @@ A key representing a specific tag within the section.
| `ON_DECK` | onDeck | | `ON_DECK` | onDeck |
| `COLLECTION` | collection | | `COLLECTION` | collection |
| `EDITION` | edition | | `EDITION` | edition |
| `GENRE` | genre |
| `YEAR` | year | | `YEAR` | year |
| `DECADE` | decade | | `DECADE` | decade |
| `DIRECTOR` | director | | `DIRECTOR` | director |
| `ACTOR` | actor |
| `COUNTRY` | country |
| `CONTENT_RATING` | contentRating | | `CONTENT_RATING` | contentRating |
| `RATING` | rating | | `RATING` | rating |
| `RESOLUTION` | resolution | | `RESOLUTION` | resolution |

View File

@@ -14,6 +14,7 @@ API Calls interacting with Plex Media Server Libraries
* [get_library_details](#get_library_details) - Get Library Details * [get_library_details](#get_library_details) - Get Library Details
* [delete_library](#delete_library) - Delete Library Section * [delete_library](#delete_library) - Delete Library Section
* [get_library_items](#get_library_items) - Get Library Items * [get_library_items](#get_library_items) - Get Library Items
* [get_all_media_library](#get_all_media_library) - Get all media of library
* [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library * [get_refresh_library_metadata](#get_refresh_library_metadata) - Refresh Metadata Of The Library
* [get_search_library](#get_search_library) - Search Library * [get_search_library](#get_search_library) - Search Library
* [get_genres_library](#get_genres_library) - Get Genres of library media * [get_genres_library](#get_genres_library) - Get Genres of library media
@@ -349,6 +350,57 @@ end
## get_all_media_library
Retrieves a list of all general media data for 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>",
)
)
req = ::PlexRubySDK::Operations::GetAllMediaLibraryRequest.new(
section_key: 9518,
type: ::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamType::TV_SHOW,
include_meta: ::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamIncludeMeta::ENABLE,
include_guids: ::PlexRubySDK::Operations::QueryParamIncludeGuids::ENABLE,
include_advanced: ::PlexRubySDK::Operations::IncludeAdvanced::ENABLE,
include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE,
include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE,
x_plex_container_start: 0,
x_plex_container_size: 50,
)
res = s.library.get_all_media_library(req)
if ! res.object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `request` | [::PlexRubySDK::Operations::GetAllMediaLibraryRequest](../../models/operations/getallmedialibraryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryResponse)](../../models/operations/getallmedialibraryresponse.md)**
## get_refresh_library_metadata ## get_refresh_library_metadata
This endpoint Refreshes all the Metadata of the library. This endpoint Refreshes all the Metadata of the library.
@@ -591,8 +643,8 @@ req = ::PlexRubySDK::Operations::GetSearchAllLibrariesRequest.new(
search_types: [ search_types: [
::PlexRubySDK::Operations::SearchTypes::PEOPLE, ::PlexRubySDK::Operations::SearchTypes::PEOPLE,
], ],
include_collections: ::PlexRubySDK::Operations::QueryParamIncludeCollections::ENABLE, include_collections: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeCollections::ENABLE,
include_external_media: ::PlexRubySDK::Operations::QueryParamIncludeExternalMedia::ENABLE, include_external_media: ::PlexRubySDK::Operations::GetSearchAllLibrariesQueryParamIncludeExternalMedia::ENABLE,
) )
res = s.library.get_search_all_libraries(req) res = s.library.get_search_all_libraries(req)

View File

@@ -368,6 +368,57 @@ module PlexRubySDK
end end
sig { params(request: T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryRequest)).returns(::PlexRubySDK::Operations::GetAllMediaLibraryResponse) }
def get_all_media_library(request)
# get_all_media_library - Get all media of library
# Retrieves a list of all general media data for this library.
#
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = Utils.generate_url(
::PlexRubySDK::Operations::GetAllMediaLibraryRequest,
base_url,
'/library/sections/{sectionKey}/all',
request
)
headers = {}
query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetAllMediaLibraryRequest, 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::GetAllMediaLibraryResponse.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::GetAllMediaLibraryResponseBody)
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::GetAllMediaLibraryBadRequest)
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::GetAllMediaLibraryUnauthorized)
res.unauthorized = out
end
elsif r.status == 404
end
res
end
sig { params(section_key: ::Integer, force: T.nilable(::PlexRubySDK::Operations::Force)).returns(::PlexRubySDK::Operations::GetRefreshLibraryMetadataResponse) } sig { params(section_key: ::Integer, force: T.nilable(::PlexRubySDK::Operations::Force)).returns(::PlexRubySDK::Operations::GetRefreshLibraryMetadataResponse) }
def get_refresh_library_metadata(section_key, force = nil) def get_refresh_library_metadata(section_key, force = nil)
# get_refresh_library_metadata - Refresh Metadata Of The Library # get_refresh_library_metadata - Refresh Metadata Of The Library

View File

@@ -431,6 +431,45 @@ module PlexRubySDK
autoload :GetLibraryItemsMediaContainer, 'plex_ruby_sdk/models/operations/get_library_items_mediacontainer.rb' autoload :GetLibraryItemsMediaContainer, 'plex_ruby_sdk/models/operations/get_library_items_mediacontainer.rb'
autoload :GetLibraryItemsResponseBody, 'plex_ruby_sdk/models/operations/get_library_items_responsebody.rb' autoload :GetLibraryItemsResponseBody, 'plex_ruby_sdk/models/operations/get_library_items_responsebody.rb'
autoload :GetLibraryItemsResponse, 'plex_ruby_sdk/models/operations/get_library_items_response.rb' autoload :GetLibraryItemsResponse, 'plex_ruby_sdk/models/operations/get_library_items_response.rb'
autoload :GetAllMediaLibraryQueryParamType, 'plex_ruby_sdk/models/operations/get_all_media_library_queryparam_type.rb'
autoload :GetAllMediaLibraryQueryParamIncludeMeta, 'plex_ruby_sdk/models/operations/get_all_media_library_queryparam_includemeta.rb'
autoload :QueryParamIncludeGuids, 'plex_ruby_sdk/models/operations/queryparam_includeguids.rb'
autoload :IncludeAdvanced, 'plex_ruby_sdk/models/operations/includeadvanced.rb'
autoload :QueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/queryparam_includecollections.rb'
autoload :QueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/queryparam_includeexternalmedia.rb'
autoload :GetAllMediaLibraryRequest, 'plex_ruby_sdk/models/operations/get_all_media_library_request.rb'
autoload :GetAllMediaLibraryLibraryErrors, 'plex_ruby_sdk/models/operations/get_all_media_library_library_errors.rb'
autoload :GetAllMediaLibraryUnauthorized, 'plex_ruby_sdk/models/operations/get_all_media_library_unauthorized.rb'
autoload :GetAllMediaLibraryErrors, 'plex_ruby_sdk/models/operations/get_all_media_library_errors.rb'
autoload :GetAllMediaLibraryBadRequest, 'plex_ruby_sdk/models/operations/get_all_media_library_badrequest.rb'
autoload :GetAllMediaLibraryFilter, 'plex_ruby_sdk/models/operations/get_all_media_library_filter.rb'
autoload :GetAllMediaLibraryActiveDirection, 'plex_ruby_sdk/models/operations/get_all_media_library_activedirection.rb'
autoload :GetAllMediaLibraryDefaultDirection, 'plex_ruby_sdk/models/operations/get_all_media_library_defaultdirection.rb'
autoload :GetAllMediaLibrarySort, 'plex_ruby_sdk/models/operations/get_all_media_library_sort.rb'
autoload :GetAllMediaLibraryField, 'plex_ruby_sdk/models/operations/get_all_media_library_field.rb'
autoload :GetAllMediaLibraryType, 'plex_ruby_sdk/models/operations/get_all_media_library_type.rb'
autoload :GetAllMediaLibraryOperator, 'plex_ruby_sdk/models/operations/get_all_media_library_operator.rb'
autoload :GetAllMediaLibraryFieldType, 'plex_ruby_sdk/models/operations/get_all_media_library_fieldtype.rb'
autoload :GetAllMediaLibraryMeta, 'plex_ruby_sdk/models/operations/get_all_media_library_meta.rb'
autoload :GetAllMediaLibraryLibraryType, 'plex_ruby_sdk/models/operations/get_all_media_library_library_type.rb'
autoload :GetAllMediaLibraryLibraryResponseType, 'plex_ruby_sdk/models/operations/get_all_media_library_library_response_type.rb'
autoload :GetAllMediaLibraryImage, 'plex_ruby_sdk/models/operations/get_all_media_library_image.rb'
autoload :GetAllMediaLibraryUltraBlurColors, 'plex_ruby_sdk/models/operations/get_all_media_library_ultrablurcolors.rb'
autoload :GetAllMediaLibraryHasThumbnail, 'plex_ruby_sdk/models/operations/get_all_media_library_hasthumbnail.rb'
autoload :GetAllMediaLibraryStream, 'plex_ruby_sdk/models/operations/get_all_media_library_stream.rb'
autoload :GetAllMediaLibraryPart, 'plex_ruby_sdk/models/operations/get_all_media_library_part.rb'
autoload :GetAllMediaLibraryMedia, 'plex_ruby_sdk/models/operations/get_all_media_library_media.rb'
autoload :GetAllMediaLibraryGenre, 'plex_ruby_sdk/models/operations/get_all_media_library_genre.rb'
autoload :GetAllMediaLibraryCountry, 'plex_ruby_sdk/models/operations/get_all_media_library_country.rb'
autoload :GetAllMediaLibraryDirector, 'plex_ruby_sdk/models/operations/get_all_media_library_director.rb'
autoload :GetAllMediaLibraryWriter, 'plex_ruby_sdk/models/operations/get_all_media_library_writer.rb'
autoload :GetAllMediaLibraryRole, 'plex_ruby_sdk/models/operations/get_all_media_library_role.rb'
autoload :Guids, 'plex_ruby_sdk/models/operations/guids.rb'
autoload :GetAllMediaLibraryCollection, 'plex_ruby_sdk/models/operations/get_all_media_library_collection.rb'
autoload :GetAllMediaLibraryMetadata, 'plex_ruby_sdk/models/operations/get_all_media_library_metadata.rb'
autoload :GetAllMediaLibraryMediaContainer, 'plex_ruby_sdk/models/operations/get_all_media_library_mediacontainer.rb'
autoload :GetAllMediaLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_all_media_library_responsebody.rb'
autoload :GetAllMediaLibraryResponse, 'plex_ruby_sdk/models/operations/get_all_media_library_response.rb'
autoload :Force, 'plex_ruby_sdk/models/operations/force.rb' autoload :Force, 'plex_ruby_sdk/models/operations/force.rb'
autoload :GetRefreshLibraryMetadataRequest, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_request.rb' autoload :GetRefreshLibraryMetadataRequest, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_request.rb'
autoload :GetRefreshLibraryMetadataLibraryErrors, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_library_errors.rb' autoload :GetRefreshLibraryMetadataLibraryErrors, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_library_errors.rb'
@@ -479,8 +518,8 @@ module PlexRubySDK
autoload :GetActorsLibraryResponseBody, 'plex_ruby_sdk/models/operations/get_actors_library_responsebody.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 :GetActorsLibraryResponse, 'plex_ruby_sdk/models/operations/get_actors_library_response.rb'
autoload :SearchTypes, 'plex_ruby_sdk/models/operations/searchtypes.rb' autoload :SearchTypes, 'plex_ruby_sdk/models/operations/searchtypes.rb'
autoload :QueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/queryparam_includecollections.rb' autoload :GetSearchAllLibrariesQueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/get_search_all_libraries_queryparam_includecollections.rb'
autoload :QueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/queryparam_includeexternalmedia.rb' autoload :GetSearchAllLibrariesQueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/get_search_all_libraries_queryparam_includeexternalmedia.rb'
autoload :GetSearchAllLibrariesRequest, 'plex_ruby_sdk/models/operations/get_search_all_libraries_request.rb' autoload :GetSearchAllLibrariesRequest, 'plex_ruby_sdk/models/operations/get_search_all_libraries_request.rb'
autoload :GetSearchAllLibrariesLibraryErrors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_errors.rb' autoload :GetSearchAllLibrariesLibraryErrors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_errors.rb'
autoload :GetSearchAllLibrariesUnauthorized, 'plex_ruby_sdk/models/operations/get_search_all_libraries_unauthorized.rb' autoload :GetSearchAllLibrariesUnauthorized, 'plex_ruby_sdk/models/operations/get_search_all_libraries_unauthorized.rb'
@@ -518,6 +557,7 @@ module PlexRubySDK
autoload :GetMediaMetaDataUnauthorized, 'plex_ruby_sdk/models/operations/get_media_meta_data_unauthorized.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 :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 :GetMediaMetaDataBadRequest, 'plex_ruby_sdk/models/operations/get_media_meta_data_badrequest.rb'
autoload :GetMediaMetaDataHasThumbnail, 'plex_ruby_sdk/models/operations/get_media_meta_data_hasthumbnail.rb'
autoload :GetMediaMetaDataStream, 'plex_ruby_sdk/models/operations/get_media_meta_data_stream.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 :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 :GetMediaMetaDataMedia, 'plex_ruby_sdk/models/operations/get_media_meta_data_media.rb'
@@ -525,8 +565,8 @@ module PlexRubySDK
autoload :GetMediaMetaDataUltraBlurColors, 'plex_ruby_sdk/models/operations/get_media_meta_data_ultrablurcolors.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 :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 :GetMediaMetaDataCountry, 'plex_ruby_sdk/models/operations/get_media_meta_data_country.rb'
autoload :Guids, 'plex_ruby_sdk/models/operations/guids.rb' autoload :GetMediaMetaDataGuids, 'plex_ruby_sdk/models/operations/get_media_meta_data_guids.rb'
autoload :Rating, 'plex_ruby_sdk/models/operations/rating.rb' autoload :Ratings, 'plex_ruby_sdk/models/operations/ratings.rb'
autoload :GetMediaMetaDataRole, 'plex_ruby_sdk/models/operations/get_media_meta_data_role.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 :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 :GetMediaMetaDataWriter, 'plex_ruby_sdk/models/operations/get_media_meta_data_writer.rb'

View File

@@ -23,8 +23,8 @@ module PlexRubySDK
field :media_tag_version, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagVersion') } } field :media_tag_version, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagVersion') } }
# Specifies whether caching is disabled. # Specifies whether caching is disabled.
field :nocache, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('nocache') } } field :nocache, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('nocache') } }
# Number of media items returned in this response.
field :size, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } } field :size, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
# URL for the thumbnail image of the media container. # URL for the thumbnail image of the media container.
field :thumb, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } } field :thumb, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } }
# The primary title of the media container. # The primary title of the media container.
@@ -39,7 +39,7 @@ module PlexRubySDK
field :directory, T.nilable(T::Array[::PlexRubySDK::Operations::GetActorsLibraryDirectory]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Directory') } } 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 } sig { params(allow_sync: T::Boolean, art: ::String, identifier: ::String, media_tag_prefix: ::String, media_tag_version: ::Integer, nocache: T::Boolean, size: ::Integer, 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) 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 @allow_sync = allow_sync
@art = art @art = art

View File

@@ -0,0 +1,19 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
#
class GetAllMediaLibraryActiveDirection < T::Enum
enums do
ASCENDING = new('asc')
DESCENDING = new('desc')
end
end
end
end

View File

@@ -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 GetAllMediaLibraryBadRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :errors, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryErrors]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('errors') } }
sig { params(errors: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryErrors])).void }
def initialize(errors: nil)
@errors = errors
end
end
end
end

View File

@@ -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 GetAllMediaLibraryCollection < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# The user-made collection this media item belongs to
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: ::String).void }
def initialize(tag: nil)
@tag = tag
end
end
end
end

View File

@@ -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 GetAllMediaLibraryCountry < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# The country of origin of this media item
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: ::String).void }
def initialize(tag: nil)
@tag = tag
end
end
end
end

View File

@@ -0,0 +1,19 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryDefaultDirection - The direction of the sort. Can be either `asc` or `desc`.
#
class GetAllMediaLibraryDefaultDirection < T::Enum
enums do
ASCENDING = new('asc')
DESCENDING = new('desc')
end
end
end
end

View File

@@ -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 GetAllMediaLibraryDirector < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# The role of Director
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: ::String).void }
def initialize(tag: nil)
@tag = tag
end
end
end
end

View File

@@ -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 GetAllMediaLibraryErrors < ::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

View File

@@ -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 GetAllMediaLibraryField < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
field :title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title') } }
field :type, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type') } }
field :sub_type, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subType') } }
sig { params(key: ::String, title: ::String, type: ::String, sub_type: T.nilable(::String)).void }
def initialize(key: nil, title: nil, type: nil, sub_type: nil)
@key = key
@title = title
@type = type
@sub_type = sub_type
end
end
end
end

View File

@@ -0,0 +1,27 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryFieldType < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :operator, T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryOperator], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Operator') } }
field :type, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type') } }
sig { params(operator: T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryOperator], type: ::String).void }
def initialize(operator: nil, type: nil)
@operator = operator
@type = type
end
end
end
end

View File

@@ -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 GetAllMediaLibraryFilter < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :filter, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('filter') } }
field :filter_type, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('filterType') } }
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
field :title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title') } }
field :type, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type') } }
field :advanced, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('advanced') } }
sig { params(filter: ::String, filter_type: ::String, key: ::String, title: ::String, type: ::String, advanced: T.nilable(T::Boolean)).void }
def initialize(filter: nil, filter_type: nil, key: nil, title: nil, type: nil, advanced: nil)
@filter = filter
@filter_type = filter_type
@key = key
@title = title
@type = type
@advanced = advanced
end
end
end
end

View File

@@ -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 GetAllMediaLibraryGenre < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# The country of origin of this media item
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: ::String).void }
def initialize(tag: nil)
@tag = tag
end
end
end
end

View File

@@ -0,0 +1,18 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryHasThumbnail - Indicates if the part has a thumbnail.
class GetAllMediaLibraryHasThumbnail < T::Enum
enums do
FALSE = new('0')
TRUE = new('1')
end
end
end
end

View File

@@ -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 GetAllMediaLibraryImage < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :alt, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('alt') } }
field :type, ::PlexRubySDK::Operations::GetAllMediaLibraryLibraryResponseType, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetAllMediaLibraryLibraryResponseType, false) } }
field :url, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('url') } }
sig { params(alt: ::String, type: ::PlexRubySDK::Operations::GetAllMediaLibraryLibraryResponseType, url: ::String).void }
def initialize(alt: nil, type: nil, url: nil)
@alt = alt
@type = type
@url = url
end
end
end
end

View File

@@ -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 GetAllMediaLibraryLibraryErrors < ::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

View File

@@ -0,0 +1,20 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryLibraryResponseType < T::Enum
enums do
COVER_POSTER = new('coverPoster')
BACKGROUND = new('background')
SNAPSHOT = new('snapshot')
CLEAR_LOGO = new('clearLogo')
end
end
end
end

View File

@@ -0,0 +1,23 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryLibraryType - The type of media content
#
class GetAllMediaLibraryLibraryType < T::Enum
enums do
MOVIE = new('movie')
TV_SHOW = new('show')
SEASON = new('season')
EPISODE = new('episode')
ARTIST = new('artist')
ALBUM = new('album')
end
end
end
end

View File

@@ -0,0 +1,79 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryMedia < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# Indicates whether voice activity is detected.
field :has_voice_activity, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasVoiceActivity') } }
# 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::GetAllMediaLibraryPart], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Part') } }
# Aspect ratio of the video.
field :aspect_ratio, T.nilable(::Float), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('aspectRatio') } }
# Number of audio channels.
field :audio_channels, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioChannels') } }
# Audio codec used.
field :audio_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioCodec') } }
# The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).
field :audio_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioProfile') } }
# Bitrate in bits per second.
field :bitrate, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('bitrate') } }
# File container type.
field :container, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
field :display_offset, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('displayOffset') } }
# Duration of the media in milliseconds.
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
field :has64bit_offsets, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('has64bitOffsets') } }
# Video height in pixels.
field :height, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('height') } }
# Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
field :optimized_for_streaming, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('optimizedForStreaming') } }
# Video codec used.
field :video_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoCodec') } }
# Frame rate of the video. Values found include NTSC, PAL, 24p
#
field :video_frame_rate, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoFrameRate') } }
# Video profile (e.g., main 10).
field :video_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
# Video resolution (e.g., 4k).
field :video_resolution, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoResolution') } }
# Video width in pixels.
field :width, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('width') } }
sig { params(has_voice_activity: T::Boolean, id: ::Integer, part: T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryPart], aspect_ratio: T.nilable(::Float), audio_channels: T.nilable(::Integer), audio_codec: T.nilable(::String), audio_profile: T.nilable(::String), bitrate: T.nilable(::Integer), container: T.nilable(::String), display_offset: T.nilable(::Integer), duration: T.nilable(::Integer), has64bit_offsets: T.nilable(T::Boolean), height: T.nilable(::Integer), optimized_for_streaming: T.nilable(::Object), video_codec: T.nilable(::String), video_frame_rate: T.nilable(::String), video_profile: T.nilable(::String), video_resolution: T.nilable(::String), width: T.nilable(::Integer)).void }
def initialize(has_voice_activity: nil, id: nil, part: nil, aspect_ratio: nil, audio_channels: nil, audio_codec: nil, audio_profile: nil, bitrate: nil, container: nil, display_offset: nil, duration: nil, has64bit_offsets: nil, height: nil, optimized_for_streaming: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil)
@has_voice_activity = has_voice_activity
@id = id
@part = part
@aspect_ratio = aspect_ratio
@audio_channels = audio_channels
@audio_codec = audio_codec
@audio_profile = audio_profile
@bitrate = bitrate
@container = container
@display_offset = display_offset
@duration = duration
@has64bit_offsets = has64bit_offsets
@height = height
@optimized_for_streaming = optimized_for_streaming
@video_codec = video_codec
@video_frame_rate = video_frame_rate
@video_profile = video_profile
@video_resolution = video_resolution
@width = width
end
end
end
end

View File

@@ -0,0 +1,79 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryMediaContainer < ::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') } }
# The content type or mode.
field :content, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('content') } }
# 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') } }
# Specifies whether caching is disabled.
field :nocache, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('nocache') } }
# Offset value for pagination.
field :offset, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('offset') } }
# Number of media items returned in this response.
field :size, ::Integer, { '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') } }
# Total number of media items in the library.
field :total_size, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('totalSize') } }
# Identifier for the view group layout.
field :view_group, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewGroup') } }
# The universally unique identifier for the library section.
field :library_section_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionUUID') } }
# The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
#
field :meta, T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryMeta), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Meta') } }
# An array of metadata items.
field :metadata, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryMetadata]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Metadata') } }
sig { params(allow_sync: T::Boolean, art: ::String, content: ::String, identifier: ::String, library_section_id: ::Integer, library_section_title: ::String, media_tag_prefix: ::String, media_tag_version: ::Integer, nocache: T::Boolean, offset: ::Integer, size: ::Integer, thumb: ::String, title1: ::String, title2: ::String, total_size: ::Integer, view_group: ::String, library_section_uuid: T.nilable(::String), meta: T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryMeta), metadata: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryMetadata])).void }
def initialize(allow_sync: nil, art: nil, content: nil, identifier: nil, library_section_id: nil, library_section_title: nil, media_tag_prefix: nil, media_tag_version: nil, nocache: nil, offset: nil, size: nil, thumb: nil, title1: nil, title2: nil, total_size: nil, view_group: nil, library_section_uuid: nil, meta: nil, metadata: nil)
@allow_sync = allow_sync
@art = art
@content = content
@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
@nocache = nocache
@offset = offset
@size = size
@thumb = thumb
@title1 = title1
@title2 = title2
@total_size = total_size
@view_group = view_group
@library_section_uuid = library_section_uuid
@meta = meta
@metadata = metadata
end
end
end
end

View File

@@ -0,0 +1,28 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
#
class GetAllMediaLibraryMeta < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :field_type, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryFieldType]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('FieldType') } }
field :type, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryType]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Type') } }
sig { params(field_type: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryFieldType]), type: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryType])).void }
def initialize(field_type: nil, type: nil)
@field_type = field_type
@type = type
end
end
end
end

View File

@@ -0,0 +1,214 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# Unknown
#
class GetAllMediaLibraryMetadata < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :added_at, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('addedAt') } }
# The art image URL for the media item.
field :art, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('art') } }
# The audience rating for the media item.
field :audience_rating, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audienceRating') } }
# The number of child items associated with this media item.
field :child_count, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('childCount') } }
# The duration of the media item in milliseconds.
field :duration, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
# The globally unique identifier for the media item.
field :guid, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('guid') } }
# The index position of the media item.
field :index, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('index') } }
# The unique key for the media item.
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
# The original release date of the media item.
field :originally_available_at, ::Date, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('originallyAvailableAt'), 'decoder': Utils.date_from_iso_format(false) } }
# The critic rating for the media item.
field :rating, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('rating') } }
# The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API.
field :rating_key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('ratingKey') } }
# The total number of seasons (for TV shows).
field :season_count, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('seasonCount') } }
# A URLfriendly version of the media title.
field :slug, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('slug') } }
# A synopsis of the media item.
field :summary, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('summary') } }
# A brief tagline for the media item.
field :tagline, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tagline') } }
# The theme URL for the media item.
field :theme, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('theme') } }
# The thumbnail image URL for the media item.
field :thumb, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('thumb') } }
# The title of the media item.
field :title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title') } }
# The sort title used for ordering media items.
field :title_sort, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('titleSort') } }
field :type, ::PlexRubySDK::Operations::GetAllMediaLibraryLibraryType, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('type'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetAllMediaLibraryLibraryType, false) } }
# The release year of the media item.
field :year, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('year') } }
# The URL for the audience rating image.
field :audience_rating_image, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audienceRatingImage') } }
# The source from which chapter data is derived.
field :chapter_source, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('chapterSource') } }
field :collection, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryCollection]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Collection') } }
# The content rating for the media item.
field :content_rating, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('contentRating') } }
field :country, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryCountry]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Country') } }
# The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available).
field :created_at_accuracy, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('createdAtAccuracy') } }
# The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC.
field :created_at_tz_offset, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('createdAtTZOffset') } }
field :director, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryDirector]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Director') } }
field :genre, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryGenre]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Genre') } }
# The art URL for the grandparent media item.
field :grandparent_art, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentArt') } }
# The GUID of the grandparent media item.
field :grandparent_guid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentGuid') } }
# The key of the grandparent media item.
field :grandparent_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentKey') } }
# The rating key of the grandparent media item.
field :grandparent_rating_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentRatingKey') } }
# The slug for the grandparent media item.
field :grandparent_slug, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentSlug') } }
# The theme URL for the grandparent media item.
field :grandparent_theme, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentTheme') } }
# The thumbnail URL for the grandparent media item.
field :grandparent_thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentThumb') } }
# The title of the grandparent media item.
field :grandparent_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('grandparentTitle') } }
field :guids, T.nilable(T::Array[::PlexRubySDK::Operations::Guids]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Guid') } }
field :image, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryImage]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Image') } }
# The Unix timestamp representing the last time the item was rated.
field :last_rated_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('lastRatedAt') } }
# Unix timestamp for when the media item was last viewed.
field :last_viewed_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('lastViewedAt') } }
# The number of leaf items (end nodes) under this media item.
field :leaf_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('leafCount') } }
field :media, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryMedia]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Media') } }
# The original title of the media item (if different).
field :original_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('originalTitle') } }
# The GUID of the parent media item.
field :parent_guid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentGuid') } }
# The index position of the parent media item.
field :parent_index, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentIndex') } }
# The key of the parent media item.
field :parent_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentKey') } }
# The rating key of the parent media item.
field :parent_rating_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentRatingKey') } }
# The thumbnail URL for the parent media item.
field :parent_thumb, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentThumb') } }
# The title of the parent media item.
field :parent_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('parentTitle') } }
# The primary extra key associated with this media item.
field :primary_extra_key, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('primaryExtraKey') } }
# The URL for the rating image.
field :rating_image, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('ratingImage') } }
field :role, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryRole]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Role') } }
# The number of times this media item has been skipped.
field :skip_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('skipCount') } }
# The studio that produced the media item.
field :studio, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('studio') } }
# A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip.
field :subtype, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subtype') } }
field :ultra_blur_colors, T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryUltraBlurColors), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('UltraBlurColors') } }
# Unix epoch datetime in seconds
field :updated_at, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('updatedAt') } }
# The rating provided by a user for the item. This value is expressed as a decimal number.
field :user_rating, T.nilable(::Float), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('userRating') } }
# The number of times this media item has been viewed.
field :view_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewCount') } }
# The number of leaf items that have been viewed.
field :viewed_leaf_count, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewedLeafCount') } }
# The current playback offset (in milliseconds).
field :view_offset, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewOffset') } }
field :writer, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryWriter]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Writer') } }
sig { params(added_at: ::Integer, art: ::String, audience_rating: ::Float, child_count: ::Integer, duration: ::Integer, guid: ::String, index: ::Integer, key: ::String, originally_available_at: ::Date, rating: ::Float, rating_key: ::String, season_count: ::Integer, slug: ::String, summary: ::String, tagline: ::String, theme: ::String, thumb: ::String, title: ::String, title_sort: ::String, type: ::PlexRubySDK::Operations::GetAllMediaLibraryLibraryType, year: ::Integer, audience_rating_image: T.nilable(::String), chapter_source: T.nilable(::String), collection: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryCollection]), content_rating: T.nilable(::String), country: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryCountry]), created_at_accuracy: T.nilable(::String), created_at_tz_offset: T.nilable(::String), director: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryDirector]), genre: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryGenre]), grandparent_art: T.nilable(::String), grandparent_guid: T.nilable(::String), grandparent_key: T.nilable(::String), grandparent_rating_key: T.nilable(::String), grandparent_slug: T.nilable(::String), grandparent_theme: T.nilable(::String), grandparent_thumb: T.nilable(::String), grandparent_title: T.nilable(::String), guids: T.nilable(T::Array[::PlexRubySDK::Operations::Guids]), image: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryImage]), last_rated_at: T.nilable(::Integer), last_viewed_at: T.nilable(::Integer), leaf_count: T.nilable(::Integer), media: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryMedia]), original_title: T.nilable(::String), parent_guid: T.nilable(::String), parent_index: T.nilable(::Integer), parent_key: T.nilable(::String), parent_rating_key: T.nilable(::String), parent_thumb: T.nilable(::String), parent_title: T.nilable(::String), primary_extra_key: T.nilable(::String), rating_image: T.nilable(::String), role: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryRole]), skip_count: T.nilable(::Integer), studio: T.nilable(::String), subtype: T.nilable(::String), ultra_blur_colors: T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryUltraBlurColors), updated_at: T.nilable(::Integer), user_rating: T.nilable(::Float), view_count: T.nilable(::Integer), viewed_leaf_count: T.nilable(::Integer), view_offset: T.nilable(::Integer), writer: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryWriter])).void }
def initialize(added_at: nil, art: nil, audience_rating: nil, child_count: nil, duration: nil, guid: nil, index: nil, key: nil, originally_available_at: nil, rating: nil, rating_key: nil, season_count: nil, slug: nil, summary: nil, tagline: nil, theme: nil, thumb: nil, title: nil, title_sort: nil, type: nil, year: nil, audience_rating_image: nil, chapter_source: nil, collection: nil, content_rating: nil, country: nil, created_at_accuracy: nil, created_at_tz_offset: nil, director: nil, genre: nil, grandparent_art: nil, grandparent_guid: nil, grandparent_key: nil, grandparent_rating_key: nil, grandparent_slug: nil, grandparent_theme: nil, grandparent_thumb: nil, grandparent_title: nil, guids: nil, image: nil, last_rated_at: nil, last_viewed_at: nil, leaf_count: nil, media: nil, original_title: nil, parent_guid: nil, parent_index: nil, parent_key: nil, parent_rating_key: nil, parent_thumb: nil, parent_title: nil, primary_extra_key: nil, rating_image: nil, role: nil, skip_count: nil, studio: nil, subtype: nil, ultra_blur_colors: nil, updated_at: nil, user_rating: nil, view_count: nil, viewed_leaf_count: nil, view_offset: nil, writer: nil)
@added_at = added_at
@art = art
@audience_rating = audience_rating
@child_count = child_count
@duration = duration
@guid = guid
@index = index
@key = key
@originally_available_at = originally_available_at
@rating = rating
@rating_key = rating_key
@season_count = season_count
@slug = slug
@summary = summary
@tagline = tagline
@theme = theme
@thumb = thumb
@title = title
@title_sort = title_sort
@type = type
@year = year
@audience_rating_image = audience_rating_image
@chapter_source = chapter_source
@collection = collection
@content_rating = content_rating
@country = country
@created_at_accuracy = created_at_accuracy
@created_at_tz_offset = created_at_tz_offset
@director = director
@genre = genre
@grandparent_art = grandparent_art
@grandparent_guid = grandparent_guid
@grandparent_key = grandparent_key
@grandparent_rating_key = grandparent_rating_key
@grandparent_slug = grandparent_slug
@grandparent_theme = grandparent_theme
@grandparent_thumb = grandparent_thumb
@grandparent_title = grandparent_title
@guids = guids
@image = image
@last_rated_at = last_rated_at
@last_viewed_at = last_viewed_at
@leaf_count = leaf_count
@media = media
@original_title = original_title
@parent_guid = parent_guid
@parent_index = parent_index
@parent_key = parent_key
@parent_rating_key = parent_rating_key
@parent_thumb = parent_thumb
@parent_title = parent_title
@primary_extra_key = primary_extra_key
@rating_image = rating_image
@role = role
@skip_count = skip_count
@studio = studio
@subtype = subtype
@ultra_blur_colors = ultra_blur_colors
@updated_at = updated_at
@user_rating = user_rating
@view_count = view_count
@viewed_leaf_count = viewed_leaf_count
@view_offset = view_offset
@writer = writer
end
end
end
end

View File

@@ -0,0 +1,27 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryOperator < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
field :title, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title') } }
sig { params(key: ::String, title: ::String).void }
def initialize(key: nil, title: nil)
@key = key
@title = title
end
end
end
end

View File

@@ -0,0 +1,69 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryPart < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# File path for the part.
field :file, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('file') } }
# Unique part identifier.
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
# Key to access this part.
field :key, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('key') } }
# File size in bytes.
field :size, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
# Indicates if the part is accessible.
field :accessible, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('accessible') } }
# The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).
field :audio_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioProfile') } }
# Container format of the part.
field :container, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
# Duration of the part in milliseconds.
field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
# Indicates if the part exists.
field :exists, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('exists') } }
field :has64bit_offsets, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('has64bitOffsets') } }
field :has_thumbnail, T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryHasThumbnail), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasThumbnail'), 'decoder': Utils.enum_from_string(::PlexRubySDK::Operations::GetAllMediaLibraryHasThumbnail, true) } }
field :indexes, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('indexes') } }
# Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
field :optimized_for_streaming, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('optimizedForStreaming') } }
field :packet_length, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('packetLength') } }
# An array of streams for this part.
field :stream, T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryStream]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Stream') } }
# Video profile for the part.
field :video_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
sig { params(file: ::String, id: ::Integer, key: ::String, size: ::Integer, accessible: T.nilable(T::Boolean), audio_profile: T.nilable(::String), container: T.nilable(::String), duration: T.nilable(::Integer), exists: T.nilable(T::Boolean), has64bit_offsets: T.nilable(T::Boolean), has_thumbnail: T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryHasThumbnail), indexes: T.nilable(::String), optimized_for_streaming: T.nilable(::Object), packet_length: T.nilable(::Integer), stream: T.nilable(T::Array[::PlexRubySDK::Operations::GetAllMediaLibraryStream]), video_profile: T.nilable(::String)).void }
def initialize(file: nil, id: nil, key: nil, size: nil, accessible: nil, audio_profile: nil, container: nil, duration: nil, exists: nil, has64bit_offsets: nil, has_thumbnail: nil, indexes: nil, optimized_for_streaming: nil, packet_length: nil, stream: nil, video_profile: nil)
@file = file
@id = id
@key = key
@size = size
@accessible = accessible
@audio_profile = audio_profile
@container = container
@duration = duration
@exists = exists
@has64bit_offsets = has64bit_offsets
@has_thumbnail = has_thumbnail
@indexes = indexes
@optimized_for_streaming = optimized_for_streaming
@packet_length = packet_length
@stream = stream
@video_profile = video_profile
end
end
end
end

View File

@@ -0,0 +1,19 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryQueryParamIncludeMeta - Adds the Meta object to the response
#
class GetAllMediaLibraryQueryParamIncludeMeta < T::Enum
enums do
DISABLE = new(0)
ENABLE = new(1)
end
end
end
end

View File

@@ -0,0 +1,29 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
# GetAllMediaLibraryQueryParamType - 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 GetAllMediaLibraryQueryParamType < 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

View File

@@ -0,0 +1,64 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Operations
class GetAllMediaLibraryRequest < ::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::GetAllMediaLibraryQueryParamType, { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
field :include_advanced, T.nilable(::PlexRubySDK::Operations::IncludeAdvanced), { 'query_param': { 'field_name': 'includeAdvanced', 'style': 'form', 'explode': true } }
field :include_collections, T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections), { 'query_param': { 'field_name': 'includeCollections', 'style': 'form', 'explode': true } }
field :include_external_media, T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia), { 'query_param': { 'field_name': 'includeExternalMedia', 'style': 'form', 'explode': true } }
# Adds the Guid object to the response
#
field :include_guids, T.nilable(::PlexRubySDK::Operations::QueryParamIncludeGuids), { 'query_param': { 'field_name': 'includeGuids', 'style': 'form', 'explode': true } }
# Adds the Meta object to the response
#
field :include_meta, T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamIncludeMeta), { '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
#
field :x_plex_container_size, T.nilable(::Integer), { 'query_param': { 'field_name': 'X-Plex-Container-Size', 'style': 'form', 'explode': true } }
# The index of the first item to return. If not specified, the first item will be returned.
# If the number of items exceeds the limit, the response will be paginated.
# By default this is 0
#
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, type: ::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamType, include_advanced: T.nilable(::PlexRubySDK::Operations::IncludeAdvanced), include_collections: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeCollections), include_external_media: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeExternalMedia), include_guids: T.nilable(::PlexRubySDK::Operations::QueryParamIncludeGuids), include_meta: T.nilable(::PlexRubySDK::Operations::GetAllMediaLibraryQueryParamIncludeMeta), x_plex_container_size: T.nilable(::Integer), x_plex_container_start: T.nilable(::Integer)).void }
def initialize(section_key: nil, type: nil, include_advanced: nil, include_collections: nil, include_external_media: nil, include_guids: nil, include_meta: nil, x_plex_container_size: nil, x_plex_container_start: nil)
@section_key = section_key
@type = type
@include_advanced = include_advanced
@include_collections = include_collections
@include_external_media = include_external_media
@include_guids = include_guids
@include_meta = include_meta
@x_plex_container_size = x_plex_container_size
@x_plex_container_start = x_plex_container_start
end
end
end
end

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