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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1

Browse Source
This commit is contained in:
speakeasybot
2025-04-07 00:10:08 +00:00
parent 2d3d3206a4
commit 1be9c77a05
852 changed files with 9666 additions and 1368 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -5,24 +5,24 @@
| 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 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *::String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `composite` | *::String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
| `filters` | *T::Boolean* | :heavy_check_mark: | UNKNOWN | true |
| `refreshing` | *T::Boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `key` | *::String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
| `type` | [::PlexRubySDK::Operations::GetAllLibrariesType](../../models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *::String* | :heavy_check_mark: | The title of the library | Movies |
| `agent` | *::String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
| `scanner` | *::String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
| `language` | *::String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
| `uuid` | *::String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `created_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 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 |
| `content` | *T::Boolean* | :heavy_check_mark: | UNKNOWN | true |
| `directory` | *T::Boolean* | :heavy_check_mark: | UNKNOWN | true |
| `content_changed_at` | *::Integer* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
| `hidden` | [::PlexRubySDK::Operations::Hidden](../../models/operations/hidden.md) | :heavy_check_mark: | N/A | 1 |
| `location` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md)> | :heavy_check_mark: | N/A | |

8
docs/models/operations/getalllibrarieslocation.md
View File

@@ -3,7 +3,7 @@
## 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 |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | The ID of the location. | 1 |
| `path` | *::String* | :heavy_check_mark: | The path to the media item. | /Movies |

8
docs/models/operations/getalllibrariesmediacontainer.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `size` | *::Integer* | :heavy_check_mark: | N/A | 5 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | N/A | false |
| `title1` | *::String* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md)> | :heavy_check_mark: | N/A | |
| `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `directory` | T::Array<[::PlexRubySDK::Operations::GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md)> | :heavy_minus_sign: | N/A | |

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

@@ -5,6 +5,6 @@ The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [::PlexRubySDK::Operations::GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetAllLibrariesMediaContainer)](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

15
docs/models/operations/getalllibrariestype.md Normal file
View File

@@ -0,0 +1,15 @@
# GetAllLibrariesType
The library type
## Values
| Name | Value |
| --------- | --------- |
| `MOVIE` | movie |
| `TV_SHOW` | show |
| `SEASON` | season |
| `EPISODE` | episode |
| `ARTIST` | artist |
| `ALBUM` | album |

4
docs/models/operations/getallmedialibrarylibraryoptimizedforstreaming.md Normal file
View File

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

42
docs/models/operations/getallmedialibrarymedia.md
View File

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

4
docs/models/operations/getallmedialibraryoptimizedforstreaming.md Normal file
View File

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

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

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

36
docs/models/operations/getallmedialibrarypart.md
View File

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

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

@@ -5,5 +5,5 @@
| 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 |
| `include_details` | [T.nilable(::PlexRubySDK::Operations::IncludeDetails)](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `include_details` | [T.nilable(::PlexRubySDK::Operations::IncludeDetails)](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `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 |

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

@@ -3,23 +3,23 @@
## 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::OptimizedForStreaming)](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_check_mark: | N/A | |
| 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::GetLibraryItemsOptimizedForStreaming)](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
| `part` | T::Array<[::PlexRubySDK::Operations::GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md)> | :heavy_check_mark: | N/A | |

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

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

4
docs/models/operations/getmediametadatalibraryoptimizedforstreaming.md Normal file
View File

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

42
docs/models/operations/getmediametadatamedia.md
View File

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

4
docs/models/operations/getmediametadataoptimizedforstreaming.md Normal file
View File

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

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

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

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

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

36
docs/models/operations/getmediametadatapart.md
View File

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

4
docs/models/operations/getrecentlyaddedoptimizedforstreaming.md Normal file
View File

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

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

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

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

@@ -5,5 +5,5 @@
| 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 |
| `force` | [T.nilable(::PlexRubySDK::Operations::Force)](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `force` | [T.nilable(::PlexRubySDK::Operations::Force)](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `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 |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `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 |
| `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -0,0 +1,11 @@
# Hidden
UNKNOWN
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

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

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

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

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

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

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

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

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

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

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