ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4

This commit is contained in:
speakeasybot
2025-06-10 00:11:24 +00:00
parent 71d9f3cf9f
commit 3520fe7644
179 changed files with 2183 additions and 2655 deletions

File diff suppressed because one or more lines are too long

View File

@@ -17,11 +17,12 @@ generation:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
ruby: ruby:
version: 0.15.0 version: 0.17.0
additionalDependencies: additionalDependencies:
development: {} development: {}
runtime: {} runtime: {}
author: LukeHagar author: LukeHagar
baseErrorName: PlexAPIError
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
defaultErrorName: APIError defaultErrorName: APIError
description: Ruby Client SDK Generated by Speakeasy description: Ruby Client SDK Generated by Speakeasy

View File

@@ -9,19 +9,19 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0 sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4 sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1749082164 - speakeasy-sdk-regen-1749514160
targets: targets:
plexruby: plexruby:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0 sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4 sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
codeSamplesNamespace: code-samples-ruby-plexruby codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:8762b4797b28c7f1c47bdbc7aa0b2e2c1b5a9c0b9596cd2c3cfb9ed7b6601caa codeSamplesRevisionDigest: sha256:6ac6bdd7073c884405e9dec6a3da0ef384298796003a1bd47f301acba68ad948
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.15.0) plex_ruby_sdk (0.17.0)
faraday faraday
faraday-multipart faraday-multipart
faraday-retry (~> 2.2.1) faraday-retry (~> 2.2.1)

View File

@@ -827,3 +827,13 @@ Based on:
- [ruby v0.15.0] . - [ruby v0.15.0] .
### Releases ### Releases
- [Ruby Gems v0.15.0] https://rubygems.org/gems/plex_ruby_sdk/versions/0.15.0 - . - [Ruby Gems v0.15.0] https://rubygems.org/gems/plex_ruby_sdk/versions/0.15.0 - .
## 2025-06-10 00:09:04
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.17.0] .
### Releases
- [Ruby Gems v0.17.0] https://rubygems.org/gems/plex_ruby_sdk/versions/0.17.0 - .

View File

@@ -1,11 +0,0 @@
# EnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `DISABLED` | 0 |

View File

@@ -1,12 +0,0 @@
# EpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `OLDEST_FIRST` | 0 |
| `NEWEST_FIRST` | 1 |

View File

@@ -3,6 +3,7 @@
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values ## Values
| Name | Value | | Name | Value |

View File

@@ -16,5 +16,5 @@
| `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series | | `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 | | `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary | | `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `view_mode` | *::String* | :heavy_check_mark: | Identifier for the view mode. | 131131 | | `view_mode` | *T.nilable(::String)* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
| `directory` | T::Array<[Models::Operations::GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | | | `directory` | T::Array<[Models::Operations::GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |

View File

@@ -4,5 +4,5 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Working NL Subs | | `tag` | *::String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

View File

@@ -4,5 +4,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *::String* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

@@ -4,5 +4,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *::Integer* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `tag` | *::String* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -10,4 +10,3 @@
| `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

@@ -4,5 +4,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Adventure | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *::String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -0,0 +1,8 @@
# GetLibraryItemsGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

View File

@@ -1,5 +1,8 @@
# GetLibraryItemsHasThumbnail # GetLibraryItemsHasThumbnail
Indicates if the part has a thumbnail.
## Values ## Values

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,9 +0,0 @@
# GetLibraryItemsLibraryOperator
## 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,5 @@
# GetLibraryItemsLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true

View File

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

View File

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

View File

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

View File

@@ -1,20 +1,14 @@
# GetLibraryItemsLibraryType # GetLibraryItemsLibraryType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Fields
| Field | Type | Required | Description | Example |
## Values | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| Name | Value | | `type` | *::String* | :heavy_check_mark: | N/A | show |
| ------------- | ------------- | | `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
| `MOVIE` | movie | | `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `TV_SHOW` | show | | `filter` | T::Array<[Models::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | |
| `SEASON` | season | | `sort` | T::Array<[Models::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | |
| `EPISODE` | episode | | `field` | T::Array<[Models::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | |
| `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

View File

@@ -1,8 +1,10 @@
# GetLibraryItemsLocation # GetLibraryItemsLocation
The folder path for the media item.
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House | | `path` | *::String* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |

View File

@@ -4,22 +4,23 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 | | `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 | | `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 | | `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 | | `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts | | `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 | | `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 | | `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc | | `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k | | `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *::String* | :heavy_check_mark: | N/A | mkv | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p | | `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: | N/A | main 10 | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `optimized_for_streaming` | [T.nilable(Models::Operations::GetLibraryItemsOptimizedForStreaming)](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `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(T.any(Models::Operations::OptimizedForStreaming1, T::Boolean))](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `part` | T::Array<[Models::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_check_mark: | N/A | | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | T::Array<[Models::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -1,33 +1,28 @@
# GetLibraryItemsMediaContainer # GetLibraryItemsMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `type` | T::Array<[Models::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)> | :heavy_minus_sign: | N/A | | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `field_type` | T::Array<[Models::Operations::GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)> | :heavy_minus_sign: | N/A | | | `total_size` | *::Integer* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 70 | | `offset` | *::Integer* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `total_size` | *::Integer* | :heavy_check_mark: | N/A | 170 | | `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary |
| `offset` | *::Integer* | :heavy_check_mark: | N/A | 0 | | `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `content` | *::String* | :heavy_check_mark: | N/A | secondary | | `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true | | `art` | *::String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `nocache` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true | | `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | TV Series |
| `library_section_id` | *::Integer* | :heavy_check_mark: | N/A | 1 | | `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `library_section_title` | *::String* | :heavy_check_mark: | N/A | Movies | | `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `library_section_uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `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/ | | `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `media_tag_version` | *::Integer* | :heavy_check_mark: | N/A | 1701731894 | | `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `title1` | *::String* | :heavy_check_mark: | N/A | Movies | | `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `title2` | *::String* | :heavy_check_mark: | N/A | Recently Released | | `view_mode` | *T.nilable(::String)* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
| `view_group` | *::String* | :heavy_check_mark: | N/A | movie | | `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
| `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 | | `metadata` | T::Array<[Models::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `metadata` | T::Array<[Models::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_minus_sign: | N/A | |
| `meta` | [T.nilable(Models::Operations::GetLibraryItemsMeta)](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | | | `meta` | [T.nilable(Models::Operations::GetLibraryItemsMeta)](../../models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

View File

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

View File

@@ -1,83 +1,88 @@
# GetLibraryItemsMetadata # GetLibraryItemsMetadata
Unknown
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 | | `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: | N/A | /library/metadata/58683 | | `key` | *::String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios | | `slug` | *::String* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 | | `type` | [Models::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | N/A | movie |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies | | `title` | *::String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 | | `banner` | *::String* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
| `type` | [Models::Operations::GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie | | `title_sort` | *::String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas | | `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/> |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 | | `rating` | *::Float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `summary` | *::String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. | | `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.6 | | `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 | | `tagline` | *::String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `thumb` | *::String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `art` | *::String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. | | `theme` | *::String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `flatten_seasons` | [T.nilable(Models::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `index` | *::Integer* | :heavy_check_mark: | The index position of the media item. | 1 |
| `episode_sort` | [T.nilable(Models::Operations::EpisodeSort)](../../models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 | | `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `enable_credits_marker_generation` | [T.nilable(Models::Operations::EnableCreditsMarkerGeneration)](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `show_ordering` | [T.nilable(Models::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute | | `child_count` | *::Integer* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `season_count` | *::Integer* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `duration` | *::Integer* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `added_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `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: | N/A | media | | `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: | N/A | /library/metadata/58684 | | `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 | | `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica | | `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `media` | T::Array<[Models::Operations::GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | | | `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<[Models::Operations::GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)> | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [T.nilable(Models::Operations::GetLibraryItemsUltraBlurColors)](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `guids` | T::Array<[Models::Operations::GetLibraryItemsGuids](../../models/operations/getlibraryitemsguids.md)> | :heavy_minus_sign: | N/A | |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | Movies |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `show_ordering` | [T.nilable(Models::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
| `flatten_seasons` | [T.nilable(Models::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
| `media` | T::Array<[Models::Operations::GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | T::Array<[Models::Operations::GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)> | :heavy_minus_sign: | N/A | | | `genre` | T::Array<[Models::Operations::GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[Models::Operations::GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)> | :heavy_minus_sign: | N/A | | | `country` | T::Array<[Models::Operations::GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[Models::Operations::GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)> | :heavy_minus_sign: | N/A | | | `director` | T::Array<[Models::Operations::GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[Models::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | | | `writer` | T::Array<[Models::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | |
| `producer` | T::Array<[Models::Operations::GetLibraryItemsProducer](../../models/operations/getlibraryitemsproducer.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[Models::Operations::GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)> | :heavy_minus_sign: | N/A | | | `collection` | T::Array<[Models::Operations::GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[Models::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | | | `role` | T::Array<[Models::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | |
| `ratings` | T::Array<[Models::Operations::Ratings](../../models/operations/ratings.md)> | :heavy_minus_sign: | N/A | |
| `similar` | T::Array<[Models::Operations::GetLibraryItemsSimilar](../../models/operations/getlibraryitemssimilar.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[Models::Operations::GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)> | :heavy_minus_sign: | N/A | | | `location` | T::Array<[Models::Operations::GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[Models::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `chapter` | T::Array<[Models::Operations::Chapter](../../models/operations/chapter.md)> | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [T.nilable(Models::Operations::GetLibraryItemsUltraBlurColors)](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `marker` | T::Array<[Models::Operations::Marker](../../models/operations/marker.md)> | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[Models::Operations::MetaDataRating](../../models/operations/metadatarating.md)> | :heavy_minus_sign: | N/A | | | `extras` | [T.nilable(Models::Operations::Extras)](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[Models::Operations::GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)> | :heavy_minus_sign: | N/A | |
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

View File

@@ -1,9 +1,4 @@
# GetLibraryItemsOptimizedForStreaming # GetLibraryItemsOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,9 @@
# GetLibraryItemsOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -4,17 +4,19 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 | | `accessible` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `exists` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `id` | *::Integer* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `key` | *T.nilable(::String)* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd | | `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` | *T.nilable(::String)* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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(T.any(Models::Operations::GetLibraryItemsOptimizedForStreaming1, T::Boolean))](../../models/operations/getlibraryitemslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [T.nilable(Models::Operations::GetLibraryItemsHasThumbnail)](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [T.nilable(Models::Operations::GetLibraryItemsHasThumbnail)](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[Models::Operations::GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,13 @@
# GetLibraryItemsProducer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

View File

@@ -4,10 +4,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 | | `tag` | *::String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg | | `role` | *T.nilable(::String)* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith | | `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

View File

@@ -0,0 +1,10 @@
# GetLibraryItemsSimilar
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | The unique similar item identifier. | 26 |
| `filter` | *::String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
| `tag` | *::String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |

View File

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

View File

@@ -1,15 +1,20 @@
# GetLibraryItemsType # GetLibraryItemsType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ## Values
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *::String* | :heavy_check_mark: | N/A | filter | | Name | Value |
| `subtype` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | clip | | ------------- | ------------- |
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows | | `MOVIE` | movie |
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false | | `TV_SHOW` | show |
| `filter` | T::Array<[Models::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | | | `SEASON` | season |
| `sort` | T::Array<[Models::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | | | `EPISODE` | episode |
| `field` | T::Array<[Models::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | | | `ARTIST` | artist |
| `ALBUM` | album |
| `TRACK` | track |
| `PHOTO_ALBUM` | photoalbum |
| `PHOTO` | photo |
| `COLLECTION` | collection |

View File

@@ -4,5 +4,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *::Integer* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `tag` | *::String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -4,7 +4,7 @@
## Fields ## Fields
| 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` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 | | `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 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
@@ -21,6 +21,6 @@
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false | | `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | 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 | | `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(T.any(Models::Operations::OptimizedForStreaming1, T::Boolean))](../../models/operations/getlibrarysectionsalloptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetLibrarySectionsAllOptimizedForStreaming1, T::Boolean))](../../models/operations/getlibrarysectionsalloptimizedforstreaming.md) | :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 | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[Models::Operations::GetLibrarySectionsAllPart](../../models/operations/getlibrarysectionsallpart.md)> | :heavy_minus_sign: | An array of parts for this media item. | | | `part` | T::Array<[Models::Operations::GetLibrarySectionsAllPart](../../models/operations/getlibrarysectionsallpart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

View File

@@ -12,8 +12,8 @@
| `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 |
| `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary | | `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 | | `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` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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_title` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | `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_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 | | `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |

View File

@@ -31,7 +31,7 @@ Unknown
| `child_count` | *::Integer* | :heavy_check_mark: | The number of child items associated with this media item. | 1 | | `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 | | `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 | | `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 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 | | `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 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 | | `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |

View File

@@ -0,0 +1,9 @@
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -4,7 +4,7 @@
## 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 |
@@ -18,6 +18,6 @@
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile for the part. | main 10 | | `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 | | `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 | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetLibrarySectionsAllOptimizedForStreaming1, T::Boolean))](../../models/operations/getlibrarysectionsalllibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetLibrarySectionsAllOptimizedForStreamingLibrary1, T::Boolean))](../../models/operations/getlibrarysectionsalllibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has_thumbnail` | [T.nilable(Models::Operations::GetLibrarySectionsAllHasThumbnail)](../../models/operations/getlibrarysectionsallhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [T.nilable(Models::Operations::GetLibrarySectionsAllHasThumbnail)](../../models/operations/getlibrarysectionsallhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[Models::Operations::GetLibrarySectionsAllStream](../../models/operations/getlibrarysectionsallstream.md)> | :heavy_minus_sign: | An array of streams for this part. | | | `stream` | T::Array<[Models::Operations::GetLibrarySectionsAllStream](../../models/operations/getlibrarysectionsallstream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

View File

@@ -4,9 +4,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [Models::Operations::GetLibrarySectionsAllStreamType](../../models/operations/getlibrarysectionsallstreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *::Integer* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `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 |

View File

@@ -1,16 +0,0 @@
# GetLibrarySectionsAllStreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -0,0 +1,11 @@
# GetMediaMetaDataAttributes
Attributes associated with the marker.
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
| `version` | *T.nilable(::Integer)* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |

View File

@@ -0,0 +1,15 @@
# GetMediaMetaDataChapter
The thumbnail for the chapter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 4 |
| `filter` | *::String* | :heavy_check_mark: | N/A | thumb=4 |
| `index` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `start_time_offset` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `end_time_offset` | *::Integer* | :heavy_check_mark: | N/A | 100100 |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |

View File

@@ -0,0 +1,8 @@
# GetMediaMetaDataExtras
## Fields
| Field | Type | Required | Description | Example |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The size of the extras. | 1 |

View File

@@ -3,6 +3,7 @@
Indicates if the part has a thumbnail. Indicates if the part has a thumbnail.
## Values ## Values
| Name | Value | | Name | Value |

View File

@@ -2,3 +2,4 @@
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true

View File

@@ -0,0 +1,15 @@
# GetMediaMetaDataMarker
The final status of the marker
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 306970 |
| `type` | *::String* | :heavy_check_mark: | N/A | credits |
| `start_time_offset` | *::Integer* | :heavy_check_mark: | N/A | 4176050 |
| `end_time_offset` | *::Integer* | :heavy_check_mark: | N/A | 4393389 |
| `final` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
| `attributes` | [T.nilable(Models::Operations::GetMediaMetaDataAttributes)](../../models/operations/getmediametadataattributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |

View File

@@ -13,14 +13,14 @@
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 | | `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 | | `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 | | `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | eac3 | | `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Video codec used. | hevc | | `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 | | `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 | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p | | `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 | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false | | `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | 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 | | `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(T.any(Models::Operations::GetMediaMetaDataOptimizedForStreaming1, T::Boolean))](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetMediaMetaDataOptimizedForStreaming1, T::Boolean))](../../models/operations/getmediametadataoptimizedforstreaming.md) | :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 | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | T::Array<[Models::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_minus_sign: | An array of parts for this media item. | | | `part` | T::Array<[Models::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -8,8 +8,8 @@
| `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 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` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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_title` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | `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_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 | | `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |

View File

@@ -31,7 +31,7 @@ Unknown
| `child_count` | *::Integer* | :heavy_check_mark: | The number of child items associated with this media item. | 1 | | `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 | | `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 | | `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 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 | | `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 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 | | `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
@@ -64,9 +64,9 @@ Unknown
| `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 | | `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<[Models::Operations::GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)> | :heavy_minus_sign: | N/A | | | `image` | T::Array<[Models::Operations::GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)> | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [T.nilable(Models::Operations::GetMediaMetaDataUltraBlurColors)](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultra_blur_colors` | [T.nilable(Models::Operations::GetMediaMetaDataUltraBlurColors)](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `library_section_id` | *::Integer* | :heavy_check_mark: | The identifier for the library section. | 1 | | `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | Movies | | `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | Movies |
| `library_section_key` | *::String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 | | `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `guids` | T::Array<[Models::Operations::GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)> | :heavy_minus_sign: | N/A | | | `guids` | T::Array<[Models::Operations::GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)> | :heavy_minus_sign: | N/A | |
| `media` | T::Array<[Models::Operations::GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)> | :heavy_minus_sign: | N/A | | | `media` | T::Array<[Models::Operations::GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | T::Array<[Models::Operations::GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)> | :heavy_minus_sign: | N/A | | | `genre` | T::Array<[Models::Operations::GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)> | :heavy_minus_sign: | N/A | |
@@ -75,9 +75,9 @@ Unknown
| `writer` | T::Array<[Models::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | N/A | | | `writer` | T::Array<[Models::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | N/A | |
| `producer` | T::Array<[Models::Operations::GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)> | :heavy_minus_sign: | N/A | | | `producer` | T::Array<[Models::Operations::GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[Models::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | N/A | | | `role` | T::Array<[Models::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | N/A | |
| `ratings` | T::Array<[Models::Operations::Ratings](../../models/operations/ratings.md)> | :heavy_minus_sign: | N/A | | | `ratings` | T::Array<[Models::Operations::GetMediaMetaDataRatings](../../models/operations/getmediametadataratings.md)> | :heavy_minus_sign: | N/A | |
| `similar` | T::Array<[Models::Operations::GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)> | :heavy_minus_sign: | N/A | | | `similar` | T::Array<[Models::Operations::GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[Models::Operations::GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)> | :heavy_minus_sign: | N/A | | | `location` | T::Array<[Models::Operations::GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)> | :heavy_minus_sign: | N/A | |
| `chapter` | T::Array<[Models::Operations::Chapter](../../models/operations/chapter.md)> | :heavy_minus_sign: | N/A | | | `chapter` | T::Array<[Models::Operations::GetMediaMetaDataChapter](../../models/operations/getmediametadatachapter.md)> | :heavy_minus_sign: | N/A | |
| `marker` | T::Array<[Models::Operations::Marker](../../models/operations/marker.md)> | :heavy_minus_sign: | N/A | | | `marker` | T::Array<[Models::Operations::GetMediaMetaDataMarker](../../models/operations/getmediametadatamarker.md)> | :heavy_minus_sign: | N/A | |
| `extras` | [T.nilable(Models::Operations::Extras)](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | | | `extras` | [T.nilable(Models::Operations::GetMediaMetaDataExtras)](../../models/operations/getmediametadataextras.md) | :heavy_minus_sign: | N/A | |

View File

@@ -8,16 +8,16 @@
| `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` | *T.nilable(::String)* | :heavy_minus_sign: | 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` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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` | *T.nilable(::String)* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *::Integer* | :heavy_check_mark: | File size in bytes. | 30649952104 | | `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
| `packet_length` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 188 | | `packet_length` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 188 |
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the part. | mkv | | `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 | | `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 | | `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 | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetMediaMetaDataOptimizedForStreamingLibrary1, T::Boolean))](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimized_for_streaming` | [T.nilable(T.any(Models::Operations::GetMediaMetaDataOptimizedForStreamingLibrary1, T::Boolean))](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [T.nilable(Models::Operations::GetMediaMetaDataHasThumbnail)](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [T.nilable(Models::Operations::GetMediaMetaDataHasThumbnail)](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[Models::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_minus_sign: | An array of streams for this part. | | | `stream` | T::Array<[Models::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_minus_sign: | N/A | |

View File

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

View File

@@ -4,12 +4,12 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [Models::Operations::GetMediaMetaDataStreamType](../../models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *::Integer* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `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` | *T.nilable(::String)* | :heavy_minus_sign: | Codec used by the stream. | hevc |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | Index of the stream. | 0 | | `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | Index of the stream. | 0 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *T.nilable(::String)* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *T.nilable(::String)* | :heavy_minus_sign: | Language of the stream. | English |
@@ -45,8 +45,8 @@
| `embedded_in_video` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive | | `embedded_in_video` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive |
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of reference frames. | 1 | | `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 | | `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) | | `display_title` | *T.nilable(::String)* | :heavy_minus_sign: | 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) | | `extended_display_title` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | `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 | | `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 | | `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |

View File

@@ -1,16 +0,0 @@
# GetMediaMetaDataStreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -32,11 +32,11 @@ Unknown
| `last_rated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 | | `last_rated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 | | `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 | | `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `library_section_id` | *::Integer* | :heavy_check_mark: | The identifier for the library section. | 1 | | `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_key` | *::String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 | | `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | Movies | | `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | Movies |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 | | `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `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 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 | | `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index position of the parent media item. | 1 | | `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 | | `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |

View File

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

View File

@@ -4,5 +4,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *::String* | :heavy_check_mark: | The country of origin of this media item | United States of America |

View File

@@ -4,5 +4,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *::Integer* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `tag` | *::String* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesDirectory
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `key` | *::String* | :heavy_check_mark: | The unique identifier path for the search result item. | /library/sections/3/all?actor=197429 |
| `library_section_id` | *::Integer* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `library_section_key` | *::String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | Movies |
| `library_section_type` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | |
| `type` | *::String* | :heavy_check_mark: | The type of the directory. | tag |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 197429 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | The filter string used to query this specific item in the library. | actor=197429 |
| `tag` | *::String* | :heavy_check_mark: | N/A | Ben Stiller |
| `tag_type` | *T.nilable(::Integer)* | :heavy_minus_sign: | The type of tag associated with this search result (e.g., Director, Actor). | |
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the tag associated with this search result. | 5d776826999c64001ec2c606 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL to the thumbnail image associated with this search result. | https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg |
| `count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items associated with this search result. | 10 |

View File

@@ -1,11 +0,0 @@
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `DISABLED` | 0 |

View File

@@ -1,12 +0,0 @@
# GetSearchAllLibrariesEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `OLDEST_FIRST` | 0 |
| `NEWEST_FIRST` | 1 |

View File

@@ -3,6 +3,7 @@
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values ## Values
| Name | Value | | Name | Value |

View File

@@ -4,5 +4,6 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Adventure | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `tag` | *::String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

View File

@@ -1,5 +1,8 @@
# GetSearchAllLibrariesHasThumbnail # GetSearchAllLibrariesHasThumbnail
Indicates if the part has a thumbnail.
## Values ## Values

View File

@@ -0,0 +1,5 @@
# GetSearchAllLibrariesLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true

View File

@@ -1,8 +1,10 @@
# GetSearchAllLibrariesLocation # GetSearchAllLibrariesLocation
The folder path for the media item.
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House | | `path` | *::String* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |

View File

@@ -4,22 +4,23 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 | | `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 | | `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 | | `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 | | `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts | | `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 | | `display_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 50 |
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 | | `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Audio codec used. | aac |
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc | | `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | Video codec used. | hevc |
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k | | `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `container` | *::String* | :heavy_check_mark: | N/A | mkv | | `container` | *T.nilable(::String)* | :heavy_minus_sign: | Container format of the media. | mp4 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p | | `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: | N/A | main 10 | | `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `optimized_for_streaming` | [T.nilable(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming)](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 | | `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(T.any(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming1, T::Boolean))](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `part` | T::Array<[Models::Operations::GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)> | :heavy_check_mark: | N/A | | | `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
| `part` | T::Array<[Models::Operations::GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -3,7 +3,14 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A | | `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `search_result` | T::Array<[Models::Operations::SearchResult](../../models/operations/searchresult.md)> | :heavy_check_mark: | N/A | | `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | 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 |
| `search_result` | T::Array<[Models::Operations::SearchResult](../../models/operations/searchresult.md)> | :heavy_check_mark: | N/A | |

View File

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

View File

@@ -1,83 +1,82 @@
# GetSearchAllLibrariesMetadata # GetSearchAllLibrariesMetadata
Unknown
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 | | `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: | N/A | /library/metadata/58683 | | `key` | *::String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios | | `slug` | *::String* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false | | `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 | | `type` | [Models::Operations::GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies | | `title` | *::String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 | | `banner` | *::String* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
| `type` | [Models::Operations::GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie | | `title_sort` | *::String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water | | `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas | | `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/> |
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 | | `rating` | *::Float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `summary` | *::String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. | | `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.6 | | `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 | | `tagline` | *::String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `thumb` | *::String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 | | `art` | *::String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. | | `theme` | *::String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `flatten_seasons` | [T.nilable(Models::Operations::GetSearchAllLibrariesFlattenSeasons)](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `index` | *::Integer* | :heavy_check_mark: | The index position of the media item. | 1 |
| `episode_sort` | [T.nilable(Models::Operations::GetSearchAllLibrariesEpisodeSort)](../../models/operations/getsearchalllibrariesepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 | | `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `enable_credits_marker_generation` | [T.nilable(Models::Operations::GetSearchAllLibrariesEnableCreditsMarkerGeneration)](../../models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 | | `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `show_ordering` | [T.nilable(Models::Operations::GetSearchAllLibrariesShowOrdering)](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute | | `child_count` | *::Integer* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `season_count` | *::Integer* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 | | `duration` | *::Integer* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `added_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `added_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media | | `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58684 | | `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe | | `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 | | `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 | | `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 | | `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica | | `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 | | `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 | | `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 | | `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | | `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `media` | T::Array<[Models::Operations::GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | | | `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<[Models::Operations::GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)> | :heavy_minus_sign: | N/A | |
| `ultra_blur_colors` | [T.nilable(Models::Operations::GetSearchAllLibrariesUltraBlurColors)](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `guids` | T::Array<[Models::Operations::GetSearchAllLibrariesGuids](../../models/operations/getsearchalllibrariesguids.md)> | :heavy_minus_sign: | N/A | |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | Movies |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `show_ordering` | [T.nilable(Models::Operations::GetSearchAllLibrariesShowOrdering)](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
| `flatten_seasons` | [T.nilable(Models::Operations::GetSearchAllLibrariesFlattenSeasons)](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
| `media` | T::Array<[Models::Operations::GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | T::Array<[Models::Operations::GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)> | :heavy_minus_sign: | N/A | | | `genre` | T::Array<[Models::Operations::GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[Models::Operations::GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)> | :heavy_minus_sign: | N/A | | | `country` | T::Array<[Models::Operations::GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[Models::Operations::GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)> | :heavy_minus_sign: | N/A | | | `director` | T::Array<[Models::Operations::GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[Models::Operations::GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)> | :heavy_minus_sign: | N/A | | | `writer` | T::Array<[Models::Operations::GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[Models::Operations::GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[Models::Operations::GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)> | :heavy_minus_sign: | N/A | | | `role` | T::Array<[Models::Operations::GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[Models::Operations::GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)> | :heavy_minus_sign: | N/A | | | `location` | T::Array<[Models::Operations::GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[Models::Operations::GetSearchAllLibrariesMediaGuid](../../models/operations/getsearchalllibrariesmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(Models::Operations::GetSearchAllLibrariesUltraBlurColors)](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[Models::Operations::GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)> | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[Models::Operations::GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)> | :heavy_minus_sign: | N/A | |
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5222500 |
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 14 |
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_extras` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parent_studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | UCP |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2010 |
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

View File

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

View File

@@ -1,9 +1,4 @@
# GetSearchAllLibrariesOptimizedForStreaming # GetSearchAllLibrariesOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreamingLibrary1
## Values
| Name | Value |
| ------ | ------ |
| `ZERO` | 0 |
| `ONE` | 1 |

View File

@@ -4,17 +4,19 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 | | `accessible` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `exists` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 | | `id` | *::Integer* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `key` | *T.nilable(::String)* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *::String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd | | `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` | *T.nilable(::String)* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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(T.any(Models::Operations::GetSearchAllLibrariesOptimizedForStreamingLibrary1, T::Boolean))](../../models/operations/getsearchalllibrarieslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
| `has_thumbnail` | [T.nilable(Models::Operations::GetSearchAllLibrariesHasThumbnail)](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 | | `has_thumbnail` | [T.nilable(Models::Operations::GetSearchAllLibrariesHasThumbnail)](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[Models::Operations::GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -4,10 +4,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 | | `id` | *::Integer* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 | | `tag` | *::String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg | | `role` | *T.nilable(::String)* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith | | `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

View File

@@ -1,11 +1,12 @@
# GetSearchAllLibrariesShowOrdering # GetSearchAllLibrariesShowOrdering
Setting that indicates the episode ordering for the show. Setting that indicates the episode ordering for the show.
None = Library default, Options:
tmdbAiring = The Movie Database (Aired), - None = Library default
aired = TheTVDB (Aired), - tmdbAiring = The Movie Database (Aired)
dvd = TheTVDB (DVD), - aired = TheTVDB (Aired)
absolute = TheTVDB (Absolute)). - dvd = TheTVDB (DVD)
- absolute = TheTVDB (Absolute)

View File

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

View File

@@ -4,5 +4,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | James Cameron | | `id` | *::Integer* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `tag` | *::String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

View File

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

View File

@@ -3,7 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `score` | *::Float* | :heavy_check_mark: | N/A | | `score` | *::Float* | :heavy_check_mark: | The score of the search result, typically a float value between 0 and 1. | 0.92 |
| `metadata` | [Models::Operations::GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A | | `directory` | [T.nilable(Models::Operations::GetSearchAllLibrariesDirectory)](../../models/operations/getsearchalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
| `metadata` | [T.nilable(Models::Operations::GetSearchAllLibrariesMetadata)](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_minus_sign: | N/A | |

View File

@@ -1,11 +1,12 @@
# ShowOrdering # ShowOrdering
Setting that indicates the episode ordering for the show. Setting that indicates the episode ordering for the show.
None = Library default, Options:
tmdbAiring = The Movie Database (Aired), - None = Library default
aired = TheTVDB (Aired), - tmdbAiring = The Movie Database (Aired)
dvd = TheTVDB (DVD), - aired = TheTVDB (Aired)
absolute = TheTVDB (Absolute)). - dvd = TheTVDB (DVD)
- absolute = TheTVDB (Absolute)

View File

@@ -4,9 +4,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `stream_type` | [Models::Operations::StreamType](../../models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 | | `stream_type` | *::Integer* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
| `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt | | `format` | *T.nilable(::String)* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `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 |

View File

@@ -1,16 +0,0 @@
# StreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Values
| Name | Value |
| ---------- | ---------- |
| `VIDEO` | 1 |
| `AUDIO` | 2 |
| `SUBTITLE` | 3 |

View File

@@ -33,10 +33,8 @@ module PlexRubySDK
autoload :Marker, 'plex_ruby_sdk/models/operations/marker.rb' autoload :Marker, 'plex_ruby_sdk/models/operations/marker.rb'
autoload :Media, 'plex_ruby_sdk/models/operations/media.rb' autoload :Media, 'plex_ruby_sdk/models/operations/media.rb'
autoload :MediaContainer, 'plex_ruby_sdk/models/operations/mediacontainer.rb' autoload :MediaContainer, 'plex_ruby_sdk/models/operations/mediacontainer.rb'
autoload :MediaGuid, 'plex_ruby_sdk/models/operations/mediaguid.rb'
autoload :MediaProvider, 'plex_ruby_sdk/models/operations/mediaprovider.rb' autoload :MediaProvider, 'plex_ruby_sdk/models/operations/mediaprovider.rb'
autoload :Meta, 'plex_ruby_sdk/models/operations/meta.rb' autoload :Meta, 'plex_ruby_sdk/models/operations/meta.rb'
autoload :MetaDataRating, 'plex_ruby_sdk/models/operations/metadatarating.rb'
autoload :Metadata, 'plex_ruby_sdk/models/operations/metadata.rb' autoload :Metadata, 'plex_ruby_sdk/models/operations/metadata.rb'
autoload :MyPlex, 'plex_ruby_sdk/models/operations/myplex.rb' autoload :MyPlex, 'plex_ruby_sdk/models/operations/myplex.rb'
autoload :Operator, 'plex_ruby_sdk/models/operations/operator.rb' autoload :Operator, 'plex_ruby_sdk/models/operations/operator.rb'
@@ -104,9 +102,7 @@ module PlexRubySDK
autoload :DeletePlaylistRequest, 'plex_ruby_sdk/models/operations/deleteplaylist_request.rb' autoload :DeletePlaylistRequest, 'plex_ruby_sdk/models/operations/deleteplaylist_request.rb'
autoload :DeletePlaylistResponse, 'plex_ruby_sdk/models/operations/deleteplaylist_response.rb' autoload :DeletePlaylistResponse, 'plex_ruby_sdk/models/operations/deleteplaylist_response.rb'
autoload :Download, 'plex_ruby_sdk/models/operations/download.rb' autoload :Download, 'plex_ruby_sdk/models/operations/download.rb'
autoload :EnableCreditsMarkerGeneration, 'plex_ruby_sdk/models/operations/enablecreditsmarkergeneration.rb'
autoload :EnablePaperTrailResponse, 'plex_ruby_sdk/models/operations/enablepapertrail_response.rb' autoload :EnablePaperTrailResponse, 'plex_ruby_sdk/models/operations/enablepapertrail_response.rb'
autoload :EpisodeSort, 'plex_ruby_sdk/models/operations/episodesort.rb'
autoload :Filter, 'plex_ruby_sdk/models/operations/filter.rb' autoload :Filter, 'plex_ruby_sdk/models/operations/filter.rb'
autoload :FlattenSeasons, 'plex_ruby_sdk/models/operations/flattenseasons.rb' autoload :FlattenSeasons, 'plex_ruby_sdk/models/operations/flattenseasons.rb'
autoload :Force, 'plex_ruby_sdk/models/operations/force.rb' autoload :Force, 'plex_ruby_sdk/models/operations/force.rb'
@@ -155,16 +151,9 @@ module PlexRubySDK
autoload :GetLibraryItemsFilter, 'plex_ruby_sdk/models/operations/get_library_items_filter.rb' autoload :GetLibraryItemsFilter, 'plex_ruby_sdk/models/operations/get_library_items_filter.rb'
autoload :GetLibraryItemsGenre, 'plex_ruby_sdk/models/operations/get_library_items_genre.rb' autoload :GetLibraryItemsGenre, 'plex_ruby_sdk/models/operations/get_library_items_genre.rb'
autoload :GetLibraryItemsImage, 'plex_ruby_sdk/models/operations/get_library_items_image.rb' autoload :GetLibraryItemsImage, 'plex_ruby_sdk/models/operations/get_library_items_image.rb'
autoload :GetLibraryItemsLibraryField, 'plex_ruby_sdk/models/operations/get_library_items_library_field.rb'
autoload :GetLibraryItemsLibraryFieldType, 'plex_ruby_sdk/models/operations/get_library_items_library_fieldtype.rb'
autoload :GetLibraryItemsLibraryFilter, 'plex_ruby_sdk/models/operations/get_library_items_library_filter.rb'
autoload :GetLibraryItemsLibraryOperator, 'plex_ruby_sdk/models/operations/get_library_items_library_operator.rb'
autoload :GetLibraryItemsLibrarySort, 'plex_ruby_sdk/models/operations/get_library_items_library_sort.rb'
autoload :GetLibraryItemsLibraryActiveDirection, 'plex_ruby_sdk/models/operations/get_library_items_library_activedirection.rb'
autoload :GetLibraryItemsLibraryDefaultDirection, 'plex_ruby_sdk/models/operations/get_library_items_library_defaultdirection.rb'
autoload :GetLibraryItemsLibraryResponse200Type, 'plex_ruby_sdk/models/operations/get_library_items_library_response_200_type.rb'
autoload :GetLibraryItemsLibraryResponseType, 'plex_ruby_sdk/models/operations/get_library_items_library_response_type.rb'
autoload :GetLibraryItemsLibraryType, 'plex_ruby_sdk/models/operations/get_library_items_library_type.rb' autoload :GetLibraryItemsLibraryType, 'plex_ruby_sdk/models/operations/get_library_items_library_type.rb'
autoload :GetLibraryItemsLibraryOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_library_items_library_optimizedforstreaming.rb'
autoload :GetLibraryItemsLibraryResponseType, 'plex_ruby_sdk/models/operations/get_library_items_library_response_type.rb'
autoload :GetLibraryItemsLocation, 'plex_ruby_sdk/models/operations/get_library_items_location.rb' autoload :GetLibraryItemsLocation, 'plex_ruby_sdk/models/operations/get_library_items_location.rb'
autoload :GetLibraryItemsMedia, 'plex_ruby_sdk/models/operations/get_library_items_media.rb' autoload :GetLibraryItemsMedia, 'plex_ruby_sdk/models/operations/get_library_items_media.rb'
autoload :GetLibraryItemsMediaContainer, 'plex_ruby_sdk/models/operations/get_library_items_mediacontainer.rb' autoload :GetLibraryItemsMediaContainer, 'plex_ruby_sdk/models/operations/get_library_items_mediacontainer.rb'
@@ -172,21 +161,24 @@ module PlexRubySDK
autoload :GetLibraryItemsMetadata, 'plex_ruby_sdk/models/operations/get_library_items_metadata.rb' autoload :GetLibraryItemsMetadata, 'plex_ruby_sdk/models/operations/get_library_items_metadata.rb'
autoload :GetLibraryItemsOperator, 'plex_ruby_sdk/models/operations/get_library_items_operator.rb' autoload :GetLibraryItemsOperator, 'plex_ruby_sdk/models/operations/get_library_items_operator.rb'
autoload :GetLibraryItemsPart, 'plex_ruby_sdk/models/operations/get_library_items_part.rb' autoload :GetLibraryItemsPart, 'plex_ruby_sdk/models/operations/get_library_items_part.rb'
autoload :GetLibraryItemsProducer, 'plex_ruby_sdk/models/operations/get_library_items_producer.rb'
autoload :GetLibraryItemsRole, 'plex_ruby_sdk/models/operations/get_library_items_role.rb' autoload :GetLibraryItemsRole, 'plex_ruby_sdk/models/operations/get_library_items_role.rb'
autoload :GetLibraryItemsSimilar, 'plex_ruby_sdk/models/operations/get_library_items_similar.rb'
autoload :GetLibraryItemsSort, 'plex_ruby_sdk/models/operations/get_library_items_sort.rb' autoload :GetLibraryItemsSort, 'plex_ruby_sdk/models/operations/get_library_items_sort.rb'
autoload :GetLibraryItemsStream, 'plex_ruby_sdk/models/operations/get_library_items_stream.rb'
autoload :GetLibraryItemsType, 'plex_ruby_sdk/models/operations/get_library_items_type.rb'
autoload :GetLibraryItemsUltraBlurColors, 'plex_ruby_sdk/models/operations/get_library_items_ultrablurcolors.rb' autoload :GetLibraryItemsUltraBlurColors, 'plex_ruby_sdk/models/operations/get_library_items_ultrablurcolors.rb'
autoload :GetLibraryItemsWriter, 'plex_ruby_sdk/models/operations/get_library_items_writer.rb' autoload :GetLibraryItemsWriter, 'plex_ruby_sdk/models/operations/get_library_items_writer.rb'
autoload :GetLibraryItemsActiveDirection, 'plex_ruby_sdk/models/operations/get_library_items_activedirection.rb' autoload :GetLibraryItemsActiveDirection, 'plex_ruby_sdk/models/operations/get_library_items_activedirection.rb'
autoload :GetLibraryItemsDefaultDirection, 'plex_ruby_sdk/models/operations/get_library_items_defaultdirection.rb' autoload :GetLibraryItemsDefaultDirection, 'plex_ruby_sdk/models/operations/get_library_items_defaultdirection.rb'
autoload :GetLibraryItemsGuids, 'plex_ruby_sdk/models/operations/get_library_items_guids.rb'
autoload :GetLibraryItemsHasThumbnail, 'plex_ruby_sdk/models/operations/get_library_items_hasthumbnail.rb' autoload :GetLibraryItemsHasThumbnail, 'plex_ruby_sdk/models/operations/get_library_items_hasthumbnail.rb'
autoload :GetLibraryItemsOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_library_items_optimizedforstreaming.rb' autoload :GetLibraryItemsOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_library_items_optimizedforstreaming.rb'
autoload :GetLibraryItemsOptimizedForStreaming1, 'plex_ruby_sdk/models/operations/get_library_items_optimizedforstreaming_1.rb'
autoload :GetLibraryItemsQueryParamIncludeMeta, 'plex_ruby_sdk/models/operations/get_library_items_queryparam_includemeta.rb' autoload :GetLibraryItemsQueryParamIncludeMeta, 'plex_ruby_sdk/models/operations/get_library_items_queryparam_includemeta.rb'
autoload :GetLibraryItemsQueryParamType, 'plex_ruby_sdk/models/operations/get_library_items_queryparam_type.rb' autoload :GetLibraryItemsQueryParamType, 'plex_ruby_sdk/models/operations/get_library_items_queryparam_type.rb'
autoload :GetLibraryItemsRequest, 'plex_ruby_sdk/models/operations/get_library_items_request.rb' autoload :GetLibraryItemsRequest, 'plex_ruby_sdk/models/operations/get_library_items_request.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 :GetLibraryItemsResponseBody, 'plex_ruby_sdk/models/operations/get_library_items_responsebody.rb' autoload :GetLibraryItemsResponseBody, 'plex_ruby_sdk/models/operations/get_library_items_responsebody.rb'
autoload :GetLibraryItemsType, 'plex_ruby_sdk/models/operations/get_library_items_type.rb'
autoload :GetLibrarySectionsAllCollection, 'plex_ruby_sdk/models/operations/get_library_sections_all_collection.rb' autoload :GetLibrarySectionsAllCollection, 'plex_ruby_sdk/models/operations/get_library_sections_all_collection.rb'
autoload :GetLibrarySectionsAllCountry, 'plex_ruby_sdk/models/operations/get_library_sections_all_country.rb' autoload :GetLibrarySectionsAllCountry, 'plex_ruby_sdk/models/operations/get_library_sections_all_country.rb'
autoload :GetLibrarySectionsAllDirector, 'plex_ruby_sdk/models/operations/get_library_sections_all_director.rb' autoload :GetLibrarySectionsAllDirector, 'plex_ruby_sdk/models/operations/get_library_sections_all_director.rb'
@@ -216,29 +208,34 @@ module PlexRubySDK
autoload :GetLibrarySectionsAllHasThumbnail, 'plex_ruby_sdk/models/operations/get_library_sections_all_hasthumbnail.rb' autoload :GetLibrarySectionsAllHasThumbnail, 'plex_ruby_sdk/models/operations/get_library_sections_all_hasthumbnail.rb'
autoload :GetLibrarySectionsAllOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_library_sections_all_optimizedforstreaming.rb' autoload :GetLibrarySectionsAllOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_library_sections_all_optimizedforstreaming.rb'
autoload :GetLibrarySectionsAllOptimizedForStreaming1, 'plex_ruby_sdk/models/operations/get_library_sections_all_optimizedforstreaming_1.rb' autoload :GetLibrarySectionsAllOptimizedForStreaming1, 'plex_ruby_sdk/models/operations/get_library_sections_all_optimizedforstreaming_1.rb'
autoload :GetLibrarySectionsAllOptimizedForStreamingLibrary1, 'plex_ruby_sdk/models/operations/get_library_sections_all_optimizedforstreaming_library_1.rb'
autoload :GetLibrarySectionsAllQueryParamIncludeMeta, 'plex_ruby_sdk/models/operations/get_library_sections_all_queryparam_includemeta.rb' autoload :GetLibrarySectionsAllQueryParamIncludeMeta, 'plex_ruby_sdk/models/operations/get_library_sections_all_queryparam_includemeta.rb'
autoload :GetLibrarySectionsAllQueryParamType, 'plex_ruby_sdk/models/operations/get_library_sections_all_queryparam_type.rb' autoload :GetLibrarySectionsAllQueryParamType, 'plex_ruby_sdk/models/operations/get_library_sections_all_queryparam_type.rb'
autoload :GetLibrarySectionsAllRequest, 'plex_ruby_sdk/models/operations/get_library_sections_all_request.rb' autoload :GetLibrarySectionsAllRequest, 'plex_ruby_sdk/models/operations/get_library_sections_all_request.rb'
autoload :GetLibrarySectionsAllResponse, 'plex_ruby_sdk/models/operations/get_library_sections_all_response.rb' autoload :GetLibrarySectionsAllResponse, 'plex_ruby_sdk/models/operations/get_library_sections_all_response.rb'
autoload :GetLibrarySectionsAllResponseBody, 'plex_ruby_sdk/models/operations/get_library_sections_all_responsebody.rb' autoload :GetLibrarySectionsAllResponseBody, 'plex_ruby_sdk/models/operations/get_library_sections_all_responsebody.rb'
autoload :GetLibrarySectionsAllStreamType, 'plex_ruby_sdk/models/operations/get_library_sections_all_streamtype.rb'
autoload :GetMediaArtsMediaContainer, 'plex_ruby_sdk/models/operations/get_media_arts_mediacontainer.rb' autoload :GetMediaArtsMediaContainer, 'plex_ruby_sdk/models/operations/get_media_arts_mediacontainer.rb'
autoload :GetMediaArtsMetadata, 'plex_ruby_sdk/models/operations/get_media_arts_metadata.rb' autoload :GetMediaArtsMetadata, 'plex_ruby_sdk/models/operations/get_media_arts_metadata.rb'
autoload :GetMediaArtsRequest, 'plex_ruby_sdk/models/operations/get_media_arts_request.rb' autoload :GetMediaArtsRequest, 'plex_ruby_sdk/models/operations/get_media_arts_request.rb'
autoload :GetMediaArtsResponse, 'plex_ruby_sdk/models/operations/get_media_arts_response.rb' autoload :GetMediaArtsResponse, 'plex_ruby_sdk/models/operations/get_media_arts_response.rb'
autoload :GetMediaArtsResponseBody, 'plex_ruby_sdk/models/operations/get_media_arts_responsebody.rb' autoload :GetMediaArtsResponseBody, 'plex_ruby_sdk/models/operations/get_media_arts_responsebody.rb'
autoload :GetMediaMetaDataAttributes, 'plex_ruby_sdk/models/operations/get_media_meta_data_attributes.rb'
autoload :GetMediaMetaDataChapter, 'plex_ruby_sdk/models/operations/get_media_meta_data_chapter.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 :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 :GetMediaMetaDataExtras, 'plex_ruby_sdk/models/operations/get_media_meta_data_extras.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 :GetMediaMetaDataImage, 'plex_ruby_sdk/models/operations/get_media_meta_data_image.rb' autoload :GetMediaMetaDataImage, 'plex_ruby_sdk/models/operations/get_media_meta_data_image.rb'
autoload :GetMediaMetaDataLibraryOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_media_meta_data_library_optimizedforstreaming.rb' autoload :GetMediaMetaDataLibraryOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_media_meta_data_library_optimizedforstreaming.rb'
autoload :GetMediaMetaDataLibraryType, 'plex_ruby_sdk/models/operations/get_media_meta_data_library_type.rb' autoload :GetMediaMetaDataLibraryType, 'plex_ruby_sdk/models/operations/get_media_meta_data_library_type.rb'
autoload :GetMediaMetaDataLocation, 'plex_ruby_sdk/models/operations/get_media_meta_data_location.rb' autoload :GetMediaMetaDataLocation, 'plex_ruby_sdk/models/operations/get_media_meta_data_location.rb'
autoload :GetMediaMetaDataMarker, 'plex_ruby_sdk/models/operations/get_media_meta_data_marker.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'
autoload :GetMediaMetaDataMediaContainer, 'plex_ruby_sdk/models/operations/get_media_meta_data_mediacontainer.rb' autoload :GetMediaMetaDataMediaContainer, 'plex_ruby_sdk/models/operations/get_media_meta_data_mediacontainer.rb'
autoload :GetMediaMetaDataMetadata, 'plex_ruby_sdk/models/operations/get_media_meta_data_metadata.rb' autoload :GetMediaMetaDataMetadata, 'plex_ruby_sdk/models/operations/get_media_meta_data_metadata.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 :GetMediaMetaDataProducer, 'plex_ruby_sdk/models/operations/get_media_meta_data_producer.rb' autoload :GetMediaMetaDataProducer, 'plex_ruby_sdk/models/operations/get_media_meta_data_producer.rb'
autoload :GetMediaMetaDataRatings, 'plex_ruby_sdk/models/operations/get_media_meta_data_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 :GetMediaMetaDataSimilar, 'plex_ruby_sdk/models/operations/get_media_meta_data_similar.rb' autoload :GetMediaMetaDataSimilar, 'plex_ruby_sdk/models/operations/get_media_meta_data_similar.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'
@@ -252,7 +249,6 @@ module PlexRubySDK
autoload :GetMediaMetaDataRequest, 'plex_ruby_sdk/models/operations/get_media_meta_data_request.rb' autoload :GetMediaMetaDataRequest, 'plex_ruby_sdk/models/operations/get_media_meta_data_request.rb'
autoload :GetMediaMetaDataResponse, 'plex_ruby_sdk/models/operations/get_media_meta_data_response.rb' autoload :GetMediaMetaDataResponse, 'plex_ruby_sdk/models/operations/get_media_meta_data_response.rb'
autoload :GetMediaMetaDataResponseBody, 'plex_ruby_sdk/models/operations/get_media_meta_data_responsebody.rb' autoload :GetMediaMetaDataResponseBody, 'plex_ruby_sdk/models/operations/get_media_meta_data_responsebody.rb'
autoload :GetMediaMetaDataStreamType, 'plex_ruby_sdk/models/operations/get_media_meta_data_streamtype.rb'
autoload :GetMediaMetaDataType, 'plex_ruby_sdk/models/operations/get_media_meta_data_type.rb' autoload :GetMediaMetaDataType, 'plex_ruby_sdk/models/operations/get_media_meta_data_type.rb'
autoload :GetMediaPostersMediaContainer, 'plex_ruby_sdk/models/operations/get_media_posters_mediacontainer.rb' autoload :GetMediaPostersMediaContainer, 'plex_ruby_sdk/models/operations/get_media_posters_mediacontainer.rb'
autoload :GetMediaPostersMetadata, 'plex_ruby_sdk/models/operations/get_media_posters_metadata.rb' autoload :GetMediaPostersMetadata, 'plex_ruby_sdk/models/operations/get_media_posters_metadata.rb'
@@ -298,28 +294,27 @@ module PlexRubySDK
autoload :GetRecentlyAddedResponseBody, 'plex_ruby_sdk/models/operations/get_recently_added_responsebody.rb' autoload :GetRecentlyAddedResponseBody, 'plex_ruby_sdk/models/operations/get_recently_added_responsebody.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 :GetRefreshLibraryMetadataResponse, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_response.rb' autoload :GetRefreshLibraryMetadataResponse, 'plex_ruby_sdk/models/operations/get_refresh_library_metadata_response.rb'
autoload :GetSearchAllLibrariesCollection, 'plex_ruby_sdk/models/operations/get_search_all_libraries_collection.rb'
autoload :GetSearchAllLibrariesCountry, 'plex_ruby_sdk/models/operations/get_search_all_libraries_country.rb' autoload :GetSearchAllLibrariesCountry, 'plex_ruby_sdk/models/operations/get_search_all_libraries_country.rb'
autoload :GetSearchAllLibrariesDirector, 'plex_ruby_sdk/models/operations/get_search_all_libraries_director.rb' autoload :GetSearchAllLibrariesDirector, 'plex_ruby_sdk/models/operations/get_search_all_libraries_director.rb'
autoload :GetSearchAllLibrariesDirectory, 'plex_ruby_sdk/models/operations/get_search_all_libraries_directory.rb'
autoload :GetSearchAllLibrariesGenre, 'plex_ruby_sdk/models/operations/get_search_all_libraries_genre.rb' autoload :GetSearchAllLibrariesGenre, 'plex_ruby_sdk/models/operations/get_search_all_libraries_genre.rb'
autoload :GetSearchAllLibrariesImage, 'plex_ruby_sdk/models/operations/get_search_all_libraries_image.rb' autoload :GetSearchAllLibrariesImage, 'plex_ruby_sdk/models/operations/get_search_all_libraries_image.rb'
autoload :GetSearchAllLibrariesLibraryOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_optimizedforstreaming.rb'
autoload :GetSearchAllLibrariesLibraryType, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_type.rb' autoload :GetSearchAllLibrariesLibraryType, 'plex_ruby_sdk/models/operations/get_search_all_libraries_library_type.rb'
autoload :GetSearchAllLibrariesLocation, 'plex_ruby_sdk/models/operations/get_search_all_libraries_location.rb' autoload :GetSearchAllLibrariesLocation, 'plex_ruby_sdk/models/operations/get_search_all_libraries_location.rb'
autoload :GetSearchAllLibrariesMedia, 'plex_ruby_sdk/models/operations/get_search_all_libraries_media.rb' autoload :GetSearchAllLibrariesMedia, 'plex_ruby_sdk/models/operations/get_search_all_libraries_media.rb'
autoload :GetSearchAllLibrariesMediaContainer, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediacontainer.rb' autoload :GetSearchAllLibrariesMediaContainer, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediacontainer.rb'
autoload :GetSearchAllLibrariesMediaGuid, 'plex_ruby_sdk/models/operations/get_search_all_libraries_mediaguid.rb'
autoload :GetSearchAllLibrariesMetaDataRating, 'plex_ruby_sdk/models/operations/get_search_all_libraries_metadatarating.rb'
autoload :GetSearchAllLibrariesMetadata, 'plex_ruby_sdk/models/operations/get_search_all_libraries_metadata.rb' autoload :GetSearchAllLibrariesMetadata, 'plex_ruby_sdk/models/operations/get_search_all_libraries_metadata.rb'
autoload :GetSearchAllLibrariesPart, 'plex_ruby_sdk/models/operations/get_search_all_libraries_part.rb' autoload :GetSearchAllLibrariesPart, 'plex_ruby_sdk/models/operations/get_search_all_libraries_part.rb'
autoload :GetSearchAllLibrariesRole, 'plex_ruby_sdk/models/operations/get_search_all_libraries_role.rb' autoload :GetSearchAllLibrariesRole, 'plex_ruby_sdk/models/operations/get_search_all_libraries_role.rb'
autoload :GetSearchAllLibrariesStream, 'plex_ruby_sdk/models/operations/get_search_all_libraries_stream.rb'
autoload :GetSearchAllLibrariesUltraBlurColors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_ultrablurcolors.rb' autoload :GetSearchAllLibrariesUltraBlurColors, 'plex_ruby_sdk/models/operations/get_search_all_libraries_ultrablurcolors.rb'
autoload :GetSearchAllLibrariesWriter, 'plex_ruby_sdk/models/operations/get_search_all_libraries_writer.rb' autoload :GetSearchAllLibrariesWriter, 'plex_ruby_sdk/models/operations/get_search_all_libraries_writer.rb'
autoload :GetSearchAllLibrariesEnableCreditsMarkerGeneration, 'plex_ruby_sdk/models/operations/get_search_all_libraries_enablecreditsmarkergeneration.rb'
autoload :GetSearchAllLibrariesEpisodeSort, 'plex_ruby_sdk/models/operations/get_search_all_libraries_episodesort.rb'
autoload :GetSearchAllLibrariesFlattenSeasons, 'plex_ruby_sdk/models/operations/get_search_all_libraries_flattenseasons.rb' autoload :GetSearchAllLibrariesFlattenSeasons, 'plex_ruby_sdk/models/operations/get_search_all_libraries_flattenseasons.rb'
autoload :GetSearchAllLibrariesGuids, 'plex_ruby_sdk/models/operations/get_search_all_libraries_guids.rb'
autoload :GetSearchAllLibrariesHasThumbnail, 'plex_ruby_sdk/models/operations/get_search_all_libraries_hasthumbnail.rb' autoload :GetSearchAllLibrariesHasThumbnail, 'plex_ruby_sdk/models/operations/get_search_all_libraries_hasthumbnail.rb'
autoload :GetSearchAllLibrariesOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_search_all_libraries_optimizedforstreaming.rb' autoload :GetSearchAllLibrariesOptimizedForStreaming, 'plex_ruby_sdk/models/operations/get_search_all_libraries_optimizedforstreaming.rb'
autoload :GetSearchAllLibrariesOptimizedForStreaming1, 'plex_ruby_sdk/models/operations/get_search_all_libraries_optimizedforstreaming_1.rb'
autoload :GetSearchAllLibrariesOptimizedForStreamingLibrary1, 'plex_ruby_sdk/models/operations/get_search_all_libraries_optimizedforstreaming_library_1.rb'
autoload :GetSearchAllLibrariesQueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/get_search_all_libraries_queryparam_includecollections.rb' autoload :GetSearchAllLibrariesQueryParamIncludeCollections, 'plex_ruby_sdk/models/operations/get_search_all_libraries_queryparam_includecollections.rb'
autoload :GetSearchAllLibrariesQueryParamIncludeExternalMedia, 'plex_ruby_sdk/models/operations/get_search_all_libraries_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'
@@ -597,7 +592,6 @@ module PlexRubySDK
autoload :StopTaskResponse, 'plex_ruby_sdk/models/operations/stoptask_response.rb' autoload :StopTaskResponse, 'plex_ruby_sdk/models/operations/stoptask_response.rb'
autoload :StopTranscodeSessionRequest, 'plex_ruby_sdk/models/operations/stoptranscodesession_request.rb' autoload :StopTranscodeSessionRequest, 'plex_ruby_sdk/models/operations/stoptranscodesession_request.rb'
autoload :StopTranscodeSessionResponse, 'plex_ruby_sdk/models/operations/stoptranscodesession_response.rb' autoload :StopTranscodeSessionResponse, 'plex_ruby_sdk/models/operations/stoptranscodesession_response.rb'
autoload :StreamType, 'plex_ruby_sdk/models/operations/streamtype.rb'
autoload :Tag, 'plex_ruby_sdk/models/operations/tag.rb' autoload :Tag, 'plex_ruby_sdk/models/operations/tag.rb'
autoload :TaskName, 'plex_ruby_sdk/models/operations/taskname.rb' autoload :TaskName, 'plex_ruby_sdk/models/operations/taskname.rb'
autoload :Tonight, 'plex_ruby_sdk/models/operations/tonight.rb' autoload :Tonight, 'plex_ruby_sdk/models/operations/tonight.rb'

View File

@@ -1,20 +0,0 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Models
module Operations
# EnableCreditsMarkerGeneration - Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
class EnableCreditsMarkerGeneration < T::Enum
enums do
LIBRARY_DEFAULT = new('-1')
DISABLED = new('0')
end
end
end
end
end

View File

@@ -1,21 +0,0 @@
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
module PlexRubySDK
module Models
module Operations
# EpisodeSort - Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
class EpisodeSort < T::Enum
enums do
LIBRARY_DEFAULT = new('-1')
OLDEST_FIRST = new('0')
NEWEST_FIRST = new('1')
end
end
end
end
end

View File

@@ -9,6 +9,7 @@ module PlexRubySDK
module Operations module Operations
# FlattenSeasons - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). # FlattenSeasons - Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
#
class FlattenSeasons < T::Enum class FlattenSeasons < T::Enum
enums do enums do
LIBRARY_DEFAULT = new('-1') LIBRARY_DEFAULT = new('-1')

View File

@@ -35,14 +35,14 @@ module PlexRubySDK
field :title2, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title2') } } field :title2, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('title2') } }
# Identifier for the view group layout. # Identifier for the view group layout.
field :view_group, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewGroup') } } field :view_group, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewGroup') } }
# Identifier for the view mode.
field :view_mode, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewMode') } }
# An array of actor entries for media items. # An array of actor entries for media items.
field :directory, T.nilable(T::Array[Models::Operations::GetActorsLibraryDirectory]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Directory') } } field :directory, T.nilable(T::Array[Models::Operations::GetActorsLibraryDirectory]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Directory') } }
# Identifier for the view mode.
field :view_mode, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('viewMode') } }
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[Models::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, directory: T.nilable(T::Array[Models::Operations::GetActorsLibraryDirectory]), view_mode: T.nilable(::String)).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, directory: nil, view_mode: nil)
@allow_sync = allow_sync @allow_sync = allow_sync
@art = art @art = art
@identifier = identifier @identifier = identifier
@@ -54,8 +54,8 @@ module PlexRubySDK
@title1 = title1 @title1 = title1
@title2 = title2 @title2 = title2
@view_group = view_group @view_group = view_group
@view_mode = view_mode
@directory = directory @directory = directory
@view_mode = view_mode
end end
def ==(other) def ==(other)
@@ -71,8 +71,8 @@ module PlexRubySDK
return false unless @title1 == other.title1 return false unless @title1 == other.title1
return false unless @title2 == other.title2 return false unless @title2 == other.title2
return false unless @view_group == other.view_group return false unless @view_group == other.view_group
return false unless @view_mode == other.view_mode
return false unless @directory == other.directory return false unless @directory == other.directory
return false unless @view_mode == other.view_mode
true true
end end
end end

View File

@@ -13,11 +13,11 @@ module PlexRubySDK
extend T::Sig extend T::Sig
include Crystalline::MetadataFields include Crystalline::MetadataFields
# The user-made collection this media item belongs to
field :tag, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } } field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: T.nilable(::String)).void } sig { params(tag: ::String).void }
def initialize(tag: nil) def initialize(tag: nil)
@tag = tag @tag = tag
end end

View File

@@ -13,17 +13,23 @@ module PlexRubySDK
extend T::Sig extend T::Sig
include Crystalline::MetadataFields include Crystalline::MetadataFields
# The unique identifier for the country.
field :tag, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } } # NOTE: This is different for each Plex server and is not globally unique.
#
field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
# The country of origin of this media item
field :tag, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('tag') } }
sig { params(tag: T.nilable(::String)).void } sig { params(id: ::Integer, tag: ::String).void }
def initialize(tag: nil) def initialize(id: nil, tag: nil)
@id = id
@tag = tag @tag = tag
end end
def ==(other) def ==(other)
return false unless other.is_a? self.class return false unless other.is_a? self.class
return false unless @id == other.id
return false unless @tag == other.tag return false unless @tag == other.tag
true true
end end

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