mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-10 04:21:03 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1
This commit is contained in:
speakeasybot
10
docs/models/operations/getactorslibrarybadrequest.md
Normal file
10
docs/models/operations/getactorslibrarybadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetActorsLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryErrors](../../models/operations/getactorslibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
11
docs/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetActorsLibraryDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `fast_key` | *::String* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||
| `key` | *::String* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||
| `title` | *::String* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
20
docs/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetActorsLibraryMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `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 |
|
||||
| `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *T::Boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *::String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *::String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `view_mode` | *::String* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetActorsLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
9
docs/models/operations/getactorslibraryrequest.md
Normal file
9
docs/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetActorsLibraryRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetActorsLibraryQueryParamType](../../models/operations/getactorslibraryqueryparamtype.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 |
|
||||
13
docs/models/operations/getactorslibraryresponse.md
Normal file
13
docs/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
|
||||
## 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::GetActorsLibraryResponseBody)](../../models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryBadRequest)](../../models/operations/getactorslibrarybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryUnauthorized)](../../models/operations/getactorslibraryunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
10
docs/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetActorsLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetActorsLibraryMediaContainer)](../../models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyLibraryErrors](../../models/operations/getmetadatabyratingkeylibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetActorsLibraryLibraryErrors](../../models/operations/getactorslibrarylibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getcountrieslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetCountriesLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetCountriesLibraryQueryParamType](../../models/operations/getcountrieslibraryqueryparamtype.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 |
|
||||
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
22
docs/models/operations/getgenreslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetGenresLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `MOVIE` | 1 |
|
||||
| `TV_SHOW` | 2 |
|
||||
| `SEASON` | 3 |
|
||||
| `EPISODE` | 4 |
|
||||
| `AUDIO` | 8 |
|
||||
| `ALBUM` | 9 |
|
||||
| `TRACK` | 10 |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetGenresLibraryQueryParamType](../../models/operations/getgenreslibraryqueryparamtype.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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetLibraryItemsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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` | [::PlexRubySDK::Operations::GetLibraryItemsQueryParamType](../../models/operations/getlibraryitemsqueryparamtype.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 |
|
||||
| `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 |
|
||||
10
docs/models/operations/getmediametadatabadrequest.md
Normal file
10
docs/models/operations/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataErrors](../../models/operations/getmediametadataerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/operations/getmediametadatacountry.md
Normal file
10
docs/models/operations/getmediametadatacountry.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The country name. | United States of America |
|
||||
13
docs/models/operations/getmediametadatadirector.md
Normal file
13
docs/models/operations/getmediametadatadirector.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
10
docs/models/operations/getmediametadataerrors.md
Normal file
10
docs/models/operations/getmediametadataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
10
docs/models/operations/getmediametadatagenre.md
Normal file
10
docs/models/operations/getmediametadatagenre.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The genre name. | Crime |
|
||||
10
docs/models/operations/getmediametadataimage.md
Normal file
10
docs/models/operations/getmediametadataimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `alt` | *::String* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||
| `url` | *::String* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||
10
docs/models/operations/getmediametadatalibraryerrors.md
Normal file
10
docs/models/operations/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataLibraryErrors
|
||||
|
||||
|
||||
## 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 |
|
||||
8
docs/models/operations/getmediametadatalocation.md
Normal file
8
docs/models/operations/getmediametadatalocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaMetaDataLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `path` | *::String* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |
|
||||
22
docs/models/operations/getmediametadatamedia.md
Normal file
22
docs/models/operations/getmediametadatamedia.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# GetMediaMetaDataMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *::Integer* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
||||
| `height` | *::Integer* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *::Float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *::Integer* | :heavy_check_mark: | Number of audio channels. | 6 |
|
||||
| `audio_codec` | *::String* | :heavy_check_mark: | Audio codec used. | eac3 |
|
||||
| `video_codec` | *::String* | :heavy_check_mark: | Video codec used. | hevc |
|
||||
| `video_resolution` | *::String* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *::String* | :heavy_check_mark: | File container type. | mkv |
|
||||
| `video_frame_rate` | *::String* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *T::Boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
16
docs/models/operations/getmediametadatamediacontainer.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetMediaMetaDataMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *::Float* | :heavy_check_mark: | N/A | 50 |
|
||||
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *::String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *::Integer* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *::Integer* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataMetadata](../../models/operations/getmediametadatametadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
||||
@@ -1,45 +1,66 @@
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
# GetMediaMetaDataMetadata
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `added_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMedia](../../models/operations/getmetadatabyratingkeymedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyGenre](../../models/operations/getmetadatabyratingkeygenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyCountry](../../models/operations/getmetadatabyratingkeycountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | T::Array<[::PlexRubySDK::Operations::Ratings](../../models/operations/ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyDirector](../../models/operations/getmetadatabyratingkeydirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyWriter](../../models/operations/getmetadatabyratingkeywriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyRole](../../models/operations/getmetadatabyratingkeyrole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | T::Array<[::PlexRubySDK::Operations::Producer](../../models/operations/producer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *::String* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
||||
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
||||
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
||||
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
||||
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
||||
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
||||
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
||||
| `key` | *::String* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
||||
| `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
||||
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
||||
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
||||
| `title` | *::String* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
||||
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_id` | *::Integer* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||
| `library_section_key` | *::String* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||
| `content_rating` | *::String* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
|
||||
| `summary` | *::String* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||
| `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
|
||||
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||
| `year` | *::Integer* | :heavy_check_mark: | The release year. | 2015 |
|
||||
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||
| `thumb` | *::String* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| `art` | *::String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_check_mark: | The original release date. | 2015-02-08 |
|
||||
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||
| `added_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
|
||||
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
||||
| `audience_rating_image` | *::String* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
||||
| `media` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)> | :heavy_check_mark: | An array of image objects. | |
|
||||
| `ultra_blur_colors` | [::PlexRubySDK::Operations::GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
||||
| `genre` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
|
||||
| `country` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)> | :heavy_minus_sign: | An array of country tags. | |
|
||||
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_check_mark: | An array of GUID objects. | |
|
||||
| `rating` | T::Array<[::PlexRubySDK::Operations::Rating](../../models/operations/rating.md)> | :heavy_check_mark: | An array of rating objects. | |
|
||||
| `role` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `director` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `writer` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `producer` | T::Array<[::PlexRubySDK::Operations::Producer](../../models/operations/producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | T::Array<[::PlexRubySDK::Operations::Similar](../../models/operations/similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `location` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
||||
18
docs/models/operations/getmediametadatapart.md
Normal file
18
docs/models/operations/getmediametadatapart.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataPart
|
||||
|
||||
|
||||
## 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` | *::Integer* | :heavy_check_mark: | 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 |
|
||||
| `container` | *::String* | :heavy_check_mark: | Container format of the part. | mkv |
|
||||
| `video_profile` | *::String* | :heavy_check_mark: | Video profile for the part. | main 10 |
|
||||
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)> | :heavy_check_mark: | An array of streams for this part. | |
|
||||
21
docs/models/operations/getmediametadatarequest.md
Normal file
21
docs/models/operations/getmediametadatarequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `rating_key` | *::Integer* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
| `include_concerts` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
||||
| `include_extras` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
||||
| `include_on_deck` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include on-deck items. | true |
|
||||
| `include_popular_leaves` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
||||
| `include_preferences` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include preferences information. | true |
|
||||
| `include_reviews` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include reviews for the content. | true |
|
||||
| `include_chapters` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include chapter details. | true |
|
||||
| `include_stations` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include station data. | true |
|
||||
| `include_external_media` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Include external media data. | true |
|
||||
| `async_augment_metadata` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
||||
| `async_check_files` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
||||
| `async_refresh_analysis` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
||||
| `async_refresh_local_media_agent` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
|
||||
13
docs/models/operations/getmediametadataresponse.md
Normal file
13
docs/models/operations/getmediametadataresponse.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataResponse
|
||||
|
||||
|
||||
## 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::GetMediaMetaDataResponseBody)](../../models/operations/getmediametadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataBadRequest)](../../models/operations/getmediametadatabadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataUnauthorized)](../../models/operations/getmediametadataunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetMetaDataByRatingKeyResponseBody
|
||||
# GetMediaMetaDataResponseBody
|
||||
|
||||
The metadata of the library item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyMediaContainer)](../../models/operations/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetMediaMetaDataMediaContainer)](../../models/operations/getmediametadatamediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmediametadatarole.md
Normal file
13
docs/models/operations/getmediametadatarole.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
53
docs/models/operations/getmediametadatastream.md
Normal file
53
docs/models/operations/getmediametadatastream.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# GetMediaMetaDataStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `stream_type` | *::Integer* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *::String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *::Integer* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *::Integer* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *::String* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `language_tag` | *::String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *::String* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `dovibl_compat_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *T.nilable(::Integer)* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *T.nilable(::String)* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *T.nilable(::Integer)* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *T.nilable(::String)* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *T.nilable(::String)* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `color_primaries` | *T.nilable(::String)* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *T.nilable(::String)* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *T.nilable(::String)* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *T.nilable(::String)* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *T.nilable(::Float)* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *T.nilable(::Integer)* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *T.nilable(::String)* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *::String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *::String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *T.nilable(::String)* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *T.nilable(::String)* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
11
docs/models/operations/getmediametadataultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataUltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `top_left` | *::String* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||
| `top_right` | *::String* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||
| `bottom_right` | *::String* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||
| `bottom_left` | *::String* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||
10
docs/models/operations/getmediametadataunauthorized.md
Normal file
10
docs/models/operations/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetMediaMetaDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataLibraryErrors](../../models/operations/getmediametadatalibraryerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
13
docs/models/operations/getmediametadatawriter.md
Normal file
13
docs/models/operations/getmediametadatawriter.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetMediaMetaDataWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyErrors](../../models/operations/getmetadatabyratingkeyerrors.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyCountry
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 116 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | country=116 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 130 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | director=130 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetMetaDataByRatingKeyGenre
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 184 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | genre=184 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Thriller |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2278 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `aspect_ratio` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `audio_channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audio_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | aac |
|
||||
| `video_codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `video_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `video_frame_rate` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `optimized_for_streaming` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
|
||||
| `has64bit_offsets` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | high |
|
||||
| `part` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyPart](../../models/operations/getmetadatabyratingkeypart.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetMetaDataByRatingKeyMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `allow_sync` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `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_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
|
||||
| `media_tag_prefix` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1698860922 |
|
||||
| `metadata` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyMetadata](../../models/operations/getmetadatabyratingkeymetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetaDataByRatingKeyPart
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `file` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 |
|
||||
| `size` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40271948 |
|
||||
| `audio_profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `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 | high |
|
||||
| `stream` | T::Array<[::PlexRubySDK::Operations::GetMetaDataByRatingKeyStream](../../models/operations/getmetadatabyratingkeystream.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `rating_key` | *::Integer* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||
@@ -1,13 +0,0 @@
|
||||
# GetMetaDataByRatingKeyResponse
|
||||
|
||||
|
||||
## 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::GetMetaDataByRatingKeyResponseBody)](../../models/operations/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyBadRequest)](../../models/operations/getmetadatabyratingkeybadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
|
||||
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetMetaDataByRatingKeyUnauthorized)](../../models/operations/getmetadatabyratingkeyunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |
|
||||
@@ -1,13 +0,0 @@
|
||||
# GetMetaDataByRatingKeyRole
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | actor=220 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Dennis Keiffer |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg |
|
||||
@@ -1,39 +0,0 @@
|
||||
# GetMetaDataByRatingKeyStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `stream_type` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `default` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `codec` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | aac |
|
||||
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `bitrate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 128 |
|
||||
| `bit_depth` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `chroma_location` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | left |
|
||||
| `chroma_subsampling` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 14520 |
|
||||
| `coded_height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 816 |
|
||||
| `coded_width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `color_primaries` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `color_range` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tv |
|
||||
| `color_space` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `color_trc` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `frame_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 24 |
|
||||
| `has_scaling_matrix` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
||||
| `height` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `level` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 40 |
|
||||
| `profile` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | lc |
|
||||
| `ref_frames` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `scan_type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `stream_identifier` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `width` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `display_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `extended_display_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `selected` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `language` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | English |
|
||||
| `language_tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | en |
|
||||
| `language_code` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | eng |
|
||||
| `sampling_rate` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 44100 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetMetaDataByRatingKeyWriter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 132 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | writer=132 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Joss Whedon |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776828880197001ec90e8f |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetPlaylistContentsQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `playlist_id` | *::Float* | :heavy_check_mark: | the ID of the playlist | |
|
||||
| `type` | [::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_directory_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `pinned_content_directory_id` | T::Array<*::Integer*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
|
||||
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||
| `type` | [::PlexRubySDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeMeta)](../../models/operations/queryparamincludemeta.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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_directory_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `pinned_content_directory_id` | T::Array<*::Integer*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
|
||||
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||
| `type` | [::PlexRubySDK::Operations::QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::QueryParamIncludeMeta)](../../models/operations/queryparamincludemeta.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 |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_directory_id` | *::Integer* | :heavy_check_mark: | The content directory ID. | |
|
||||
| `pinned_content_directory_id` | *T.nilable(::String)* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
|
||||
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||
| `type` | [::PlexRubySDK::Operations::Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::IncludeMeta)](../../models/operations/includemeta.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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `content_directory_id` | *::Integer* | :heavy_check_mark: | The content directory ID. | |
|
||||
| `pinned_content_directory_id` | *T.nilable(::String)* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
|
||||
| `section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||
| `type` | [::PlexRubySDK::Operations::Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_meta` | [T.nilable(::PlexRubySDK::Operations::IncludeMeta)](../../models/operations/includemeta.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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetSearchLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `section_key` | *::Integer* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [::PlexRubySDK::Operations::GetSearchLibraryQueryParamType](../../models/operations/getsearchlibraryqueryparamtype.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 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetTopWatchedContentQueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `include_guids` | *T.nilable(::Integer)* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| 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 |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | tvdb://2337 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *::String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||
@@ -5,8 +5,9 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 221 |
|
||||
| `filter` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | producer=221 |
|
||||
| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Barry Mendel |
|
||||
| `tag_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 5d776826961905001eb90e2b |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *::String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *T.nilable(::String)* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -1,6 +1,6 @@
|
||||
# QueryParamType
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
10
docs/models/operations/rating.md
Normal file
10
docs/models/operations/rating.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Rating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *::String* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||
| `value` | *::Float* | :heavy_check_mark: | The rating value. | 9 |
|
||||
| `type` | *::String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Ratings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | themoviedb://image.rating |
|
||||
| `value` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 7.4 |
|
||||
| `type` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | audience |
|
||||
10
docs/models/operations/similar.md
Normal file
10
docs/models/operations/similar.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Similar
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *::Integer* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `filter` | *::String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `tag` | *::String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
@@ -1,6 +1,6 @@
|
||||
# Type
|
||||
|
||||
The type of media to retrieve.
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
|
||||
Reference in New Issue
Block a user