mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-09 12:47:44 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2
This commit is contained in:
speakeasybot
9
docs/models/operations/action.md
Normal file
9
docs/models/operations/action.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Action
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `id` | *::String* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||
| `key` | *::String* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||
12
docs/models/operations/activedirection.md
Normal file
12
docs/models/operations/activedirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `ASCENDING` | asc |
|
||||
| `DESCENDING` | desc |
|
||||
8
docs/models/operations/collection.md
Normal file
8
docs/models/operations/collection.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Collection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
12
docs/models/operations/defaultdirection.md
Normal file
12
docs/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# DefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `ASCENDING` | asc |
|
||||
| `DESCENDING` | desc |
|
||||
@@ -3,8 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
|
||||
| `directory` | T::Array<[::PlexRubySDK::Operations::GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *::String* | :heavy_check_mark: | N/A | |
|
||||
| `flavor` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | global |
|
||||
| `scrobble_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||
| `unscrobble_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||
| `directory` | T::Array<[::PlexRubySDK::Operations::GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `action` | T::Array<[::PlexRubySDK::Operations::Action](../../models/operations/action.md)> | :heavy_minus_sign: | N/A | |
|
||||
9
docs/models/operations/flattenseasons.md
Normal file
9
docs/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# FlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `FALSE` | 0 |
|
||||
| `TRUE` | 1 |
|
||||
10
docs/models/operations/getlibraryitemsimage.md
Normal file
10
docs/models/operations/getlibraryitemsimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `alt` | *::String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *::String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
11
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
11
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsLibraryType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *::String* | :heavy_check_mark: | N/A | show |
|
||||
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,17 +5,19 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `bitrate` | *::Integer* | :heavy_check_mark: | N/A | 25025 |
|
||||
| `width` | *::Integer* | :heavy_check_mark: | N/A | 3840 |
|
||||
| `height` | *::Integer* | :heavy_check_mark: | N/A | 2072 |
|
||||
| `aspect_ratio` | *::Float* | :heavy_check_mark: | N/A | 1.85 |
|
||||
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audio_channels` | *::Integer* | :heavy_check_mark: | N/A | 6 |
|
||||
| `audio_codec` | *::String* | :heavy_check_mark: | N/A | eac3 |
|
||||
| `video_codec` | *::String* | :heavy_check_mark: | N/A | hevc |
|
||||
| `video_resolution` | *::String* | :heavy_check_mark: | N/A | 4k |
|
||||
| `container` | *::String* | :heavy_check_mark: | N/A | mkv |
|
||||
| `video_frame_rate` | *::String* | :heavy_check_mark: | N/A | 24p |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -6,7 +6,11 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `size` | *::Integer* | :heavy_check_mark: | N/A | 70 |
|
||||
| `total_size` | *::Integer* | :heavy_check_mark: | N/A | 170 |
|
||||
| `offset` | *::Integer* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *::String* | :heavy_check_mark: | N/A | secondary |
|
||||
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `nocache` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *::Object* | :heavy_check_mark: | N/A | |
|
||||
@@ -20,5 +24,5 @@
|
||||
| `view_group` | *::String* | :heavy_check_mark: | N/A | movie |
|
||||
| `view_mode` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_check_mark: | N/A | |
|
||||
| `meta` | [T.nilable(::PlexRubySDK::Operations::Meta)](../../models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -5,24 +5,30 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *::String* | :heavy_check_mark: | N/A | 58683 |
|
||||
| `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 |
|
||||
| `key` | *::String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `type` | *::String* | :heavy_check_mark: | N/A | movie |
|
||||
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `type` | [::PlexRubySDK::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | 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. |
|
||||
| `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. |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *::Integer* | :heavy_check_mark: | N/A | 2022 |
|
||||
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::FlattenSeasons)](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::ShowOrdering)](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `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` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `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 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
@@ -32,15 +38,19 @@
|
||||
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)> | :heavy_check_mark: | N/A | |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | T::Array<[::PlexRubySDK::Operations::Collection](../../models/operations/collection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `media_guid` | T::Array<[::PlexRubySDK::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::UltraBlurColors)](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `image` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
@@ -54,7 +64,7 @@
|
||||
| `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: | N/A | 66 |
|
||||
| `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 |
|
||||
|
||||
@@ -5,10 +5,13 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | N/A | 11558112 |
|
||||
| `file` | *::String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `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 |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | N/A | main 10 |
|
||||
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
|
||||
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::HasThumbnail)](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -9,6 +9,6 @@
|
||||
| `tag` | [::PlexRubySDK::Operations::Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `include_guids` | [T.nilable(::PlexRubySDK::Operations::IncludeGuids)](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::IncludeMeta)](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `type` | [::PlexRubySDK::Operations::Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `type` | [T.nilable(::PlexRubySDK::Operations::Type)](../../models/operations/type.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -3,11 +3,13 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
|
||||
| `default_direction` | *::String* | :heavy_check_mark: | N/A | 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `default` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `active_direction` | [T.nilable(::PlexRubySDK::Operations::ActiveDirection)](../../models/operations/activedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `default_direction` | [::PlexRubySDK::Operations::DefaultDirection](../../models/operations/defaultdirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `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 |
|
||||
@@ -1,14 +1,14 @@
|
||||
# GetLibraryItemsType
|
||||
|
||||
The type of media content
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *::String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *::String* | :heavy_check_mark: | N/A | show |
|
||||
| `title` | *::String* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *T::Boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | movie |
|
||||
| `TV_SHOW` | show |
|
||||
| `SEASON` | season |
|
||||
| `EPISODE` | episode |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
@@ -46,4 +46,5 @@ Logged in user details
|
||||
| `title` | *::String* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||||
| `two_factor_enabled` | *T::Boolean* | :heavy_check_mark: | If two-factor authentication is enabled | |
|
||||
| `username` | *::String* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *::String* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `uuid` | *::String* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `attribution_partner` | *::String* | :heavy_check_mark: | N/A | <nil> |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
9
docs/models/operations/hasthumbnail.md
Normal file
9
docs/models/operations/hasthumbnail.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# HasThumbnail
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `FALSE` | 0 |
|
||||
| `TRUE` | 1 |
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)> | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md)> | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -47,5 +47,6 @@ Returns the user account data with a valid auth token
|
||||
| `two_factor_enabled` | *T::Boolean* | :heavy_check_mark: | If two-factor authentication is enabled | |
|
||||
| `username` | *::String* | :heavy_check_mark: | The account username | Username |
|
||||
| `uuid` | *::String* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||||
| `attribution_partner` | *::String* | :heavy_check_mark: | N/A | <nil> |
|
||||
| `past_subscriptions` | T::Array<[::PlexRubySDK::Operations::PastSubscription](../../models/operations/pastsubscription.md)> | :heavy_check_mark: | N/A | |
|
||||
| `trials` | T::Array<[::PlexRubySDK::Operations::Trials](../../models/operations/trials.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
20
docs/models/operations/showordering.md
Normal file
20
docs/models/operations/showordering.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `NONE` | None |
|
||||
| `TMDB_AIRING` | tmdbAiring |
|
||||
| `AIRED` | aired |
|
||||
| `DVD` | dvd |
|
||||
| `ABSOLUTE` | absolute |
|
||||
@@ -14,6 +14,6 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `SHOW` | 2 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
11
docs/models/operations/ultrablurcolors.md
Normal file
11
docs/models/operations/ultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# UltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `top_left` | *::String* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `top_right` | *::String* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottom_right` | *::String* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottom_left` | *::String* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
Reference in New Issue
Block a user