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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0

Browse Source
This commit is contained in:
speakeasybot
2024-10-03 00:09:32 +00:00
parent d8100e0e9a
commit 0e73ee21f2
155 changed files with 2883 additions and 1722 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
docs/models/operations/features.md
View File

@@ -1,102 +0,0 @@
# Features
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -3,26 +3,26 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *::String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *::String* | :heavy_check_mark: | N/A | 1 |
| `type` | *::String* | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Movies |
| `agent` | *::String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *::String* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *::String* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_check_mark: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `art` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *::String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *::String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *::String* | :heavy_check_mark: | N/A | 1 |
| `type` | *::String* | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | N/A | Movies |
| `agent` | *::String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *::String* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *::String* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *::String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scanned_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | N/A | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *::Integer* | :heavy_check_mark: | N/A | 0 |
| `location` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,9 @@
# GetAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `path` | *::String* | :heavy_check_mark: | N/A | /movies |

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

@@ -10,4 +10,4 @@
| `height` | *::Integer* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

@@ -0,0 +1,8 @@
# GetLibraryItemsLocation
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

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

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `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_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 |
| `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` | *::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 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsOptimizedForStreaming)](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |

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

@@ -52,6 +52,7 @@
| `writer` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMediaGuid](../../models/operations/getlibraryitemsmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors)](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md)> | :heavy_minus_sign: | N/A | |

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

@@ -7,14 +7,14 @@
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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 |
| `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` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetLibraryItemsHasThumbnail)](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)> | :heavy_minus_sign: | N/A | |

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

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

6
docs/models/operations/getmediaprovidersrequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

@@ -15,7 +15,7 @@
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Season 2 |
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Reacher |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11 |

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

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | The platform of the client application. | Roku |

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

@@ -52,6 +52,7 @@
| `writer` | T::Array<[::PlexRubySDK::Operations::Writer](../../models/operations/writer.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::Collection](../../models/operations/collection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::Role](../../models/operations/role.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::Location](../../models/operations/location.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::Operations::MediaGuid](../../models/operations/mediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::UltraBlurColors)](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::MetaDataRating](../../models/operations/metadatarating.md)> | :heavy_minus_sign: | N/A | |

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |

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

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

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

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

25
docs/models/operations/getsearchalllibrariesmedia.md Normal file
View File

@@ -0,0 +1,25 @@
# GetSearchAllLibrariesMedia
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | 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_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | dts |
| `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` | *::String* | :heavy_check_mark: | 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 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesOptimizedForStreaming)](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `size` | *::Float* | :heavy_check_mark: | N/A |
| `search_result` | T::Array<[::PlexRubySDK::Operations::SearchResult](../../models/operations/searchresult.md)> | :heavy_check_mark: | N/A |

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

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

81
docs/models/operations/getsearchalllibrariesmetadata.md Normal file
View File

@@ -0,0 +1,81 @@
# GetSearchAllLibrariesMetadata
## Fields
| 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 |
| `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 |
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [::PlexRubySDK::Operations::GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.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` | *::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` | *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::GetSearchAllLibrariesFlattenSeasons)](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `show_ordering` | [T.nilable(::PlexRubySDK::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/> | 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 |
| `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` | *::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 |
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 |
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)> | :heavy_minus_sign: | N/A | |
| `collection` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)> | :heavy_minus_sign: | N/A | |
| `location` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)> | :heavy_minus_sign: | N/A | |
| `media_guid` | T::Array<[::PlexRubySDK::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(::PlexRubySDK::Operations::GetSearchAllLibrariesUltraBlurColors)](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)> | :heavy_minus_sign: | N/A | |
| `image` | T::Array<[::PlexRubySDK::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 |

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

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

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

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

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

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesPart
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 119542 |
| `key` | *::String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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 |
| `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 |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesHasThumbnail)](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)> | :heavy_minus_sign: | N/A | |

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

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

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

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesResponseBody)](../../models/operations/getsearchalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesBadRequest)](../../models/operations/getsearchalllibrariesbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesUnauthorized)](../../models/operations/getsearchalllibrariesunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

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

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [::PlexRubySDK::Operations::GetSearchAllLibrariesMediaContainer](../../models/operations/getsearchalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |

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

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

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

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesShowOrdering
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 |

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

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

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

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

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

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUltraBlurColors
## 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 |

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

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

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

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

12
docs/models/operations/getserverresourcesrequest.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::PlexRubySDK::Operations::IncludeRelay)](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

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

@@ -10,4 +10,4 @@
| `height` | *::Integer* | :heavy_check_mark: | N/A | 396 |
| `min_size` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `upscale` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

16
docs/models/operations/gettokenbypinidrequest.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | The platform of the client application. | Roku |

102
docs/models/operations/gettokendetailsfeatures.md
View File

@@ -1,102 +0,0 @@
# GetTokenDetailsFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::GetTokenDetailsFeatures](../../models/operations/gettokendetailsfeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::GetTokenDetailsAuthenticationResponseStatus)](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

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

@@ -13,4 +13,4 @@
| `include_external_media` | [T.nilable(::PlexRubySDK::Operations::IncludeExternalMedia)](../../models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `x_plex_container_start` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `x_plex_container_size` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `x_plex_token` | *::String* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

7
docs/models/operations/location.md
View File

@@ -3,7 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 1 |
| `path` | *::String* | :heavy_check_mark: | N/A | /movies |
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `path` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /TV Shows/House |

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

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `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 |
| `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_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 |
| `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` | *::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 |
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `has_voice_activity` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `optimized_for_streaming` | [T.nilable(::PlexRubySDK::Operations::OptimizedForStreaming)](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |

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

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `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 |
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | 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 |
| `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` | *::String* | :heavy_check_mark: | N/A | main 10 |
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | main 10 |
| `indexes` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | sd |
| `has_thumbnail` | [T.nilable(::PlexRubySDK::Operations::HasThumbnail)](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | T::Array<[::PlexRubySDK::Operations::Stream](../../models/operations/stream.md)> | :heavy_minus_sign: | N/A | |

102
docs/models/operations/postuserssignindataauthenticationfeatures.md
View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataAuthenticationFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationFeatures](../../models/operations/postuserssignindataauthenticationfeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationResponseStatus)](../../models/operations/postuserssignindataauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

102
docs/models/operations/postuserssignindatafeatures.md
View File

@@ -1,102 +0,0 @@
# PostUsersSignInDataFeatures
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `ANDROID_DOLBY_VISION` | Android - Dolby Vision |
| `ANDROID_PI_P` | Android - PiP |
| `CU_SUNSET` | CU Sunset |
| `HRK_ENABLE_EUR` | HRK_enable_EUR |
| `TREBLE_SHOW_FEATURES` | TREBLE-show-features |
| `AD_COUNTDOWN_TIMER` | ad-countdown-timer |
| `ADAPTIVE_BITRATE` | adaptive_bitrate |
| `ALBUM_TYPES` | album-types |
| `ALLOW_DVR` | allow_dvr |
| `AMAZON_LOOP_DEBUG` | amazon-loop-debug |
| `AVOD_AD_ANALYSIS` | avod-ad-analysis |
| `AVOD_NEW_MEDIA` | avod-new-media |
| `BLACKLIST_GET_SIGNIN` | blacklist_get_signin |
| `BOOST_VOICES` | boost-voices |
| `CAMERA_UPLOAD` | camera_upload |
| `CLIENT_RADIO_STATIONS` | client-radio-stations |
| `CLOUDFLARE_TURNSTILE_REQUIRED` | cloudflare-turnstile-required |
| `CLOUDSYNC` | cloudsync |
| `COLLECTIONS` | collections |
| `COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS` | comments_and_replies_push_notifications |
| `COMMUNITY_ACCESS_PLEX_TV` | community_access_plex_tv |
| `COMPANIONS_SONOS` | companions_sonos |
| `CONTENT_FILTER` | content_filter |
| `CUSTOM_HOME_REMOVAL` | custom-home-removal |
| `DISABLE_HOME_USER_FRIENDSHIPS` | disable_home_user_friendships |
| `DISABLE_SHARING_FRIENDSHIPS` | disable_sharing_friendships |
| `DOWNLOADS_GATING` | downloads-gating |
| `DRM_SUPPORT` | drm_support |
| `DVR` | dvr |
| `DVR_BLOCK_UNSUPPORTED_COUNTRIES` | dvr-block-unsupported-countries |
| `EPG_RECENT_CHANNELS` | epg-recent-channels |
| `EXCLUDE_RESTRICTIONS` | exclude restrictions |
| `FEDERATED_AUTH` | federated-auth |
| `FRIEND_REQUEST_PUSH_NOTIFICATIONS` | friend_request_push_notifications |
| `GRANDFATHER_SYNC` | grandfather-sync |
| `GUIDED_UPGRADE` | guided-upgrade |
| `HARDWARE_TRANSCODING` | hardware_transcoding |
| `HOME` | home |
| `HWTRANSCODE` | hwtranscode |
| `IMAGGA_V2` | imagga-v2 |
| `INCREASE_PASSWORD_COMPLEXITY` | increase-password-complexity |
| `IOS14_PRIVACY_BANNER` | ios14-privacy-banner |
| `ITERABLE_NOTIFICATION_TOKENS` | iterable-notification-tokens |
| `ITEM_CLUSTERS` | item_clusters |
| `KEEP_PAYMENT_METHOD` | keep-payment-method |
| `KEVIN_BACON` | kevin-bacon |
| `KOREA_CONSENT` | korea-consent |
| `LE_ISRG_ROOT_X1` | le_isrg_root_x1 |
| `LETS_ENCRYPT` | lets_encrypt |
| `LIGHTNING_DVR_PIVOT` | lightning-dvr-pivot |
| `LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS` | live-tv-support-incomplete-segments |
| `LIVETV` | livetv |
| `LYRICS` | lyrics |
| `METADATA_SEARCH` | metadata_search |
| `MUSIC_ANALYSIS` | music-analysis |
| `MUSIC_VIDEOS` | music_videos |
| `NEW_PLEX_PASS_PRICES` | new_plex_pass_prices |
| `NEWS_PROVIDER_SUNSET_MODAL` | news-provider-sunset-modal |
| `NOMINATIM` | nominatim |
| `PASS` | pass |
| `PHOTOS_FAVORITES` | photos-favorites |
| `PHOTOS_METADATA_EDITION` | photos-metadata-edition |
| `PHOTOS_V6_EDIT` | photosV6-edit |
| `PHOTOS_V6_TV_ALBUMS` | photosV6-tv-albums |
| `PMS_HEALTH` | pms_health |
| `PREMIUM_DASHBOARD` | premium-dashboard |
| `PREMIUM_MUSIC_METADATA` | premium_music_metadata |
| `RADIO` | radio |
| `RATE_LIMIT_CLIENT_TOKEN` | rate-limit-client-token |
| `SCROBBLING_SERVICE_PLEX_TV` | scrobbling-service-plex-tv |
| `SESSION_BANDWIDTH_RESTRICTIONS` | session_bandwidth_restrictions |
| `SESSION_KICK` | session_kick |
| `SHARED_SERVER_NOTIFICATION` | shared_server_notification |
| `SHARED_SOURCE_NOTIFICATION` | shared_source_notification |
| `SIGNIN_NOTIFICATION` | signin_notification |
| `SIGNIN_WITH_APPLE` | signin_with_apple |
| `SILENCE_REMOVAL` | silence-removal |
| `SLEEP_TIMER` | sleep-timer |
| `SPRING_SERVE_AD_PROVIDER` | spring_serve_ad_provider |
| `SYNC` | sync |
| `SWEET_FADES` | sweet-fades |
| `TRANSCODER_CACHE` | transcoder_cache |
| `TRAILERS` | trailers |
| `TUNER_SHARING` | tuner-sharing |
| `TWO_FACTOR_AUTHENTICATION` | two-factor-authentication |
| `UNSUPPORTEDTUNERS` | unsupportedtuners |
| `UPGRADE_3DS2` | upgrade-3ds2 |
| `VISUALIZERS` | visualizers |
| `VOD_SCHEMA` | vod-schema |
| `VOD_CLOUDFLARE` | vod_cloudflare |
| `VOLUME_LEVELING` | volume-leveling |
| `WATCH_TOGETHER_INVITE` | watch-together-invite |
| `WATCHLIST_RSS` | watchlist-rss |
| `WEB_SERVER_DASHBOARD` | web_server_dashboard |
| `WEBHOOKS` | webhooks |

16
docs/models/operations/postuserssignindatarequest.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Chrome |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *T.nilable(::String)* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::PostUsersSignInDataFeatures](../../models/operations/postuserssignindatafeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataAuthenticationStatus)](../../models/operations/postuserssignindataauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

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

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

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

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

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

@@ -0,0 +1,9 @@
# SearchResult
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `score` | *::Float* | :heavy_check_mark: | N/A |
| `metadata` | [::PlexRubySDK::Operations::GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A |

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

@@ -0,0 +1,12 @@
# SearchTypes
## Values
| Name | Value |
| -------------- | -------------- |
| `MOVIES` | movies |
| `MUSIC` | music |
| `OTHER_VIDEOS` | otherVideos |
| `PEOPLE` | people |
| `TV` | tv |

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

@@ -7,7 +7,7 @@ If the account’s Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | T::Array<[::PlexRubySDK::Operations::Features](../../models/operations/features.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `features` | T::Array<*::String*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `subscribed_at` | *T.nilable(::String)* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [T.nilable(::PlexRubySDK::Operations::GetTokenDetailsAuthenticationStatus)](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |