LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.555.2

Browse Source
This commit is contained in:
speakeasybot
2025-06-04 00:26:20 +00:00
parent 55b5c2b3dd
commit bc02ecef34
204 changed files with 2222 additions and 1924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Models/Requests/Country.md
View File

@@ -5,8 +5,8 @@ The filter query string for country media items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | N/A | 259 |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `Filter` | *string* | :heavy_minus_sign: | N/A | country=19 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `Filter` | *string* | :heavy_check_mark: | N/A | country=19 |

10
docs/Models/Requests/Director.md
View File

@@ -3,6 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `TagKey` | *string* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

10
docs/Models/Requests/Genre.md
View File

@@ -5,8 +5,8 @@ The filter query string for similar items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `Id` | *long* | :heavy_check_mark: | N/A | 259 |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

20
docs/Models/Requests/GetActorsLibraryQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

20
docs/Models/Requests/GetAllLibrariesType.md
View File

@@ -5,11 +5,15 @@ The library type
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

9
docs/Models/Requests/GetAllMediaLibraryFieldType.md
View File

@@ -1,9 +0,0 @@
# GetAllMediaLibraryFieldType
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
| `Operator` | List<[GetAllMediaLibraryOperator](../../Models/Requests/GetAllMediaLibraryOperator.md)> | :heavy_check_mark: | N/A | |

8
docs/Models/Requests/GetAllMediaLibraryGuids.md
View File

@@ -1,8 +0,0 @@
# GetAllMediaLibraryGuids
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

10
docs/Models/Requests/GetAllMediaLibraryImage.md
View File

@@ -1,10 +0,0 @@
# GetAllMediaLibraryImage
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `Type` | [GetAllMediaLibraryLibraryResponseType](../../Models/Requests/GetAllMediaLibraryLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
| `Url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

18
docs/Models/Requests/GetAllMediaLibraryLibraryOptimizedForStreaming.md
View File

@@ -1,18 +0,0 @@
# GetAllMediaLibraryLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### GetAllMediaLibraryOptimizedForStreaming1
```csharp
GetAllMediaLibraryLibraryOptimizedForStreaming.CreateGetAllMediaLibraryOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetAllMediaLibraryLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

16
docs/Models/Requests/GetAllMediaLibraryLibraryType.md
View File

@@ -1,16 +0,0 @@
# GetAllMediaLibraryLibraryType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

26
docs/Models/Requests/GetAllMediaLibraryMedia.md
View File

@@ -1,26 +0,0 @@
# GetAllMediaLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `Width` | *int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `Height` | *int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `AspectRatio` | *float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `DisplayOffset` | *int* | :heavy_minus_sign: | N/A | 50 |
| `AudioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `VideoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
| `VideoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `Container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `HasVoiceActivity` | *bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `OptimizedForStreaming` | [GetAllMediaLibraryOptimizedForStreaming](../../Models/Requests/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `Part` | List<[GetAllMediaLibraryPart](../../Models/Requests/GetAllMediaLibraryPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

12
docs/Models/Requests/GetAllMediaLibraryMeta.md
View File

@@ -1,12 +0,0 @@
# GetAllMediaLibraryMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Type` | List<[GetAllMediaLibraryType](../../Models/Requests/GetAllMediaLibraryType.md)> | :heavy_minus_sign: | N/A |
| `FieldType` | List<[GetAllMediaLibraryFieldType](../../Models/Requests/GetAllMediaLibraryFieldType.md)> | :heavy_minus_sign: | N/A |

18
docs/Models/Requests/GetAllMediaLibraryOptimizedForStreaming.md
View File

@@ -1,18 +0,0 @@
# GetAllMediaLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### OptimizedForStreaming1
```csharp
GetAllMediaLibraryOptimizedForStreaming.CreateOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetAllMediaLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

23
docs/Models/Requests/GetAllMediaLibraryPart.md
View File

@@ -1,23 +0,0 @@
# GetAllMediaLibraryPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `Accessible` | *bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `Exists` | *bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `Id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `Size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `PacketLength` | *int* | :heavy_minus_sign: | N/A | 188 |
| `Container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [GetAllMediaLibraryLibraryOptimizedForStreaming](../../Models/Requests/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `HasThumbnail` | [GetAllMediaLibraryHasThumbnail](../../Models/Requests/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | List<[GetAllMediaLibraryStream](../../Models/Requests/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

22
docs/Models/Requests/GetAllMediaLibraryQueryParamType.md
View File

@@ -1,22 +0,0 @@
# GetAllMediaLibraryQueryParamType
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 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

10
docs/Models/Requests/GetAllMediaLibraryResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetAllMediaLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetAllMediaLibraryMediaContainer](../../Models/Requests/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

15
docs/Models/Requests/GetAllMediaLibrarySort.md
View File

@@ -1,15 +0,0 @@
# GetAllMediaLibrarySort
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
| `ActiveDirection` | [GetAllMediaLibraryActiveDirection](../../Models/Requests/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DefaultDirection` | [GetAllMediaLibraryDefaultDirection](../../Models/Requests/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DescKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `FirstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `Title` | *string* | :heavy_check_mark: | N/A | Title |

58
docs/Models/Requests/GetAllMediaLibraryStream.md
View File

@@ -1,58 +0,0 @@
# GetAllMediaLibraryStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `StreamType` | [GetAllMediaLibraryStreamType](../../Models/Requests/GetAllMediaLibraryStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
| `Format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `Default` | *bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `Index` | *int* | :heavy_minus_sign: | Index of the stream. | 0 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `Language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
| `LanguageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `LanguageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
| `HeaderCompression` | *bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `DOVIBLCompatID` | *int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `DOVIBLPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `DOVIELPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `DOVILevel` | *int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `DOVIPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `DOVIProfile` | *int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `DOVIRPUPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `DOVIVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `BitDepth` | *int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `ChromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `ChromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `CodedHeight` | *int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `CodedWidth` | *int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `ClosedCaptions` | *bool* | :heavy_minus_sign: | N/A | true |
| `ColorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `ColorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `ColorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `ColorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `FrameRate` | *float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `Key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `Height` | *int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `Level` | *int* | :heavy_minus_sign: | Video level. | 150 |
| `Original` | *bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `HasScalingMatrix` | *bool* | :heavy_minus_sign: | N/A | false |
| `Profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `ScanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `EmbeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
| `RefFrames` | *int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `Width` | *int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `Selected` | *bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `Forced` | *bool* | :heavy_minus_sign: | N/A | true |
| `Channels` | *int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `AudioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `SamplingRate` | *int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `CanAutoSync` | *bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `HearingImpaired` | *bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `Dub` | *bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `Title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

15
docs/Models/Requests/GetAllMediaLibraryType.md
View File

@@ -1,15 +0,0 @@
# GetAllMediaLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetAllMediaLibraryFilter](../../Models/Requests/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[GetAllMediaLibrarySort](../../Models/Requests/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[GetAllMediaLibraryField](../../Models/Requests/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | |

20
docs/Models/Requests/GetCountriesLibraryQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

20
docs/Models/Requests/GetGenresLibraryQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

22
docs/Models/Requests/GetLibraryItemsLibraryType.md
View File

@@ -1,16 +1,20 @@
# GetLibraryItemsLibraryType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

2
docs/Models/Requests/GetLibraryItemsMetadata.md
View File

@@ -13,7 +13,7 @@
| `LibrarySectionID` | *long* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `Type` | [GetLibraryItemsLibraryType](../../Models/Requests/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `Type` | [GetLibraryItemsLibraryType](../../Models/Requests/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `Slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `ContentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |

20
docs/Models/Requests/GetLibraryItemsQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

2
docs/Models/Requests/GetAllMediaLibraryActiveDirection.md → docs/Models/Requests/GetLibrarySectionsAllActiveDirection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryActiveDirection
# GetLibrarySectionsAllActiveDirection
The direction of the sort. Can be either `asc` or `desc`.

2
docs/Models/Requests/GetAllMediaLibraryCollection.md → docs/Models/Requests/GetLibrarySectionsAllCollection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryCollection
# GetLibrarySectionsAllCollection
## Fields

2
docs/Models/Requests/GetAllMediaLibraryCountry.md → docs/Models/Requests/GetLibrarySectionsAllCountry.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryCountry
# GetLibrarySectionsAllCountry
## Fields

2
docs/Models/Requests/GetAllMediaLibraryDefaultDirection.md → docs/Models/Requests/GetLibrarySectionsAllDefaultDirection.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryDefaultDirection
# GetLibrarySectionsAllDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.

2
docs/Models/Requests/GetAllMediaLibraryDirector.md → docs/Models/Requests/GetLibrarySectionsAllDirector.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryDirector
# GetLibrarySectionsAllDirector
## Fields

2
docs/Models/Requests/GetAllMediaLibraryField.md → docs/Models/Requests/GetLibrarySectionsAllField.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryField
# GetLibrarySectionsAllField
## Fields

9
docs/Models/Requests/GetLibrarySectionsAllFieldType.md Normal file
View File

@@ -0,0 +1,9 @@
# GetLibrarySectionsAllFieldType
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
| `Operator` | List<[GetLibrarySectionsAllOperator](../../Models/Requests/GetLibrarySectionsAllOperator.md)> | :heavy_check_mark: | N/A | |

2
docs/Models/Requests/GetAllMediaLibraryFilter.md → docs/Models/Requests/GetLibrarySectionsAllFilter.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryFilter
# GetLibrarySectionsAllFilter
## Fields

2
docs/Models/Requests/GetAllMediaLibraryGenre.md → docs/Models/Requests/GetLibrarySectionsAllGenre.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryGenre
# GetLibrarySectionsAllGenre
## Fields

8
docs/Models/Requests/GetLibrarySectionsAllGuids.md Normal file
View File

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

2
docs/Models/Requests/GetAllMediaLibraryHasThumbnail.md → docs/Models/Requests/GetLibrarySectionsAllHasThumbnail.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryHasThumbnail
# GetLibrarySectionsAllHasThumbnail
Indicates if the part has a thumbnail.

10
docs/Models/Requests/GetLibrarySectionsAllImage.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibrarySectionsAllImage
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `Type` | [GetLibrarySectionsAllLibraryResponseType](../../Models/Requests/GetLibrarySectionsAllLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
| `Url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

18
docs/Models/Requests/GetLibrarySectionsAllLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetLibrarySectionsAllLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### GetLibrarySectionsAllOptimizedForStreaming1
```csharp
GetLibrarySectionsAllLibraryOptimizedForStreaming.CreateGetLibrarySectionsAllOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetLibrarySectionsAllLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

2
docs/Models/Requests/GetAllMediaLibraryLibraryResponseType.md → docs/Models/Requests/GetLibrarySectionsAllLibraryResponseType.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryLibraryResponseType
# GetLibrarySectionsAllLibraryResponseType
## Values

20
docs/Models/Requests/GetLibrarySectionsAllLibraryType.md Normal file
View File

@@ -0,0 +1,20 @@
# GetLibrarySectionsAllLibraryType
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

26
docs/Models/Requests/GetLibrarySectionsAllMedia.md Normal file
View File

@@ -0,0 +1,26 @@
# GetLibrarySectionsAllMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `Width` | *int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `Height` | *int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `AspectRatio` | *float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `DisplayOffset` | *int* | :heavy_minus_sign: | N/A | 50 |
| `AudioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `VideoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
| `VideoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `Container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `HasVoiceActivity` | *bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `OptimizedForStreaming` | [GetLibrarySectionsAllOptimizedForStreaming](../../Models/Requests/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `Part` | List<[GetLibrarySectionsAllPart](../../Models/Requests/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |

6
docs/Models/Requests/GetAllMediaLibraryMediaContainer.md → docs/Models/Requests/GetLibrarySectionsAllMediaContainer.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryMediaContainer
# GetLibrarySectionsAllMediaContainer
## Fields
@@ -22,5 +22,5 @@
| `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 |
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `Meta` | [GetAllMediaLibraryMeta](../../Models/Requests/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `Metadata` | List<[GetAllMediaLibraryMetadata](../../Models/Requests/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
| `Meta` | [GetLibrarySectionsAllMeta](../../Models/Requests/GetLibrarySectionsAllMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `Metadata` | List<[GetLibrarySectionsAllMetadata](../../Models/Requests/GetLibrarySectionsAllMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

12
docs/Models/Requests/GetLibrarySectionsAllMeta.md Normal file
View File

@@ -0,0 +1,12 @@
# GetLibrarySectionsAllMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Type` | List<[GetLibrarySectionsAllType](../../Models/Requests/GetLibrarySectionsAllType.md)> | :heavy_minus_sign: | N/A |
| `FieldType` | List<[GetLibrarySectionsAllFieldType](../../Models/Requests/GetLibrarySectionsAllFieldType.md)> | :heavy_minus_sign: | N/A |

24
docs/Models/Requests/GetAllMediaLibraryMetadata.md → docs/Models/Requests/GetLibrarySectionsAllMetadata.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryMetadata
# GetLibrarySectionsAllMetadata
Unknown
@@ -13,7 +13,7 @@ Unknown
| `Guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `Slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `Studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `Type` | [GetAllMediaLibraryLibraryType](../../Models/Requests/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
| `Type` | [GetLibrarySectionsAllLibraryType](../../Models/Requests/GetLibrarySectionsAllLibraryType.md) | :heavy_check_mark: | N/A | movie |
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `TitleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `ContentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
@@ -62,13 +62,13 @@ Unknown
| `CreatedAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `LastViewedAt` | *int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `UserRating` | *float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `Image` | List<[GetAllMediaLibraryImage](../../Models/Requests/GetAllMediaLibraryImage.md)> | :heavy_minus_sign: | N/A | |
| `UltraBlurColors` | [GetAllMediaLibraryUltraBlurColors](../../Models/Requests/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetAllMediaLibraryMedia](../../Models/Requests/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetAllMediaLibraryGenre](../../Models/Requests/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetAllMediaLibraryCountry](../../Models/Requests/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetAllMediaLibraryDirector](../../Models/Requests/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetAllMediaLibraryWriter](../../Models/Requests/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetAllMediaLibraryRole](../../Models/Requests/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[GetAllMediaLibraryGuids](../../Models/Requests/GetAllMediaLibraryGuids.md)> | :heavy_minus_sign: | N/A | |
| `Collection` | List<[GetAllMediaLibraryCollection](../../Models/Requests/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
| `Image` | List<[GetLibrarySectionsAllImage](../../Models/Requests/GetLibrarySectionsAllImage.md)> | :heavy_minus_sign: | N/A | |
| `UltraBlurColors` | [GetLibrarySectionsAllUltraBlurColors](../../Models/Requests/GetLibrarySectionsAllUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `Guids` | List<[GetLibrarySectionsAllGuids](../../Models/Requests/GetLibrarySectionsAllGuids.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetLibrarySectionsAllMedia](../../Models/Requests/GetLibrarySectionsAllMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetLibrarySectionsAllGenre](../../Models/Requests/GetLibrarySectionsAllGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetLibrarySectionsAllCountry](../../Models/Requests/GetLibrarySectionsAllCountry.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetLibrarySectionsAllDirector](../../Models/Requests/GetLibrarySectionsAllDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetLibrarySectionsAllWriter](../../Models/Requests/GetLibrarySectionsAllWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetLibrarySectionsAllRole](../../Models/Requests/GetLibrarySectionsAllRole.md)> | :heavy_minus_sign: | N/A | |
| `Collection` | List<[GetLibrarySectionsAllCollection](../../Models/Requests/GetLibrarySectionsAllCollection.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetAllMediaLibraryOperator.md → docs/Models/Requests/GetLibrarySectionsAllOperator.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryOperator
# GetLibrarySectionsAllOperator
## Fields

18
docs/Models/Requests/GetLibrarySectionsAllOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetLibrarySectionsAllOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### OptimizedForStreaming1
```csharp
GetLibrarySectionsAllOptimizedForStreaming.CreateOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetLibrarySectionsAllOptimizedForStreaming.CreateBoolean(/* values here */);
```

2
docs/Models/Requests/GetAllMediaLibraryOptimizedForStreaming1.md → docs/Models/Requests/GetLibrarySectionsAllOptimizedForStreaming1.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryOptimizedForStreaming1
# GetLibrarySectionsAllOptimizedForStreaming1
## Values

23
docs/Models/Requests/GetLibrarySectionsAllPart.md Normal file
View File

@@ -0,0 +1,23 @@
# GetLibrarySectionsAllPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `Accessible` | *bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `Exists` | *bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `Id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `Size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `PacketLength` | *int* | :heavy_minus_sign: | N/A | 188 |
| `Container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [GetLibrarySectionsAllLibraryOptimizedForStreaming](../../Models/Requests/GetLibrarySectionsAllLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `HasThumbnail` | [GetLibrarySectionsAllHasThumbnail](../../Models/Requests/GetLibrarySectionsAllHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | List<[GetLibrarySectionsAllStream](../../Models/Requests/GetLibrarySectionsAllStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

2
docs/Models/Requests/GetAllMediaLibraryQueryParamIncludeMeta.md → docs/Models/Requests/GetLibrarySectionsAllQueryParamIncludeMeta.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryQueryParamIncludeMeta
# GetLibrarySectionsAllQueryParamIncludeMeta
Adds the Meta object to the response

24
docs/Models/Requests/GetLibrarySectionsAllQueryParamType.md Normal file
View File

@@ -0,0 +1,24 @@
# GetLibrarySectionsAllQueryParamType
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 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

6
docs/Models/Requests/GetAllMediaLibraryRequest.md → docs/Models/Requests/GetLibrarySectionsAllRequest.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryRequest
# GetLibrarySectionsAllRequest
## Fields
@@ -6,8 +6,8 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :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` | [GetAllMediaLibraryQueryParamType](../../Models/Requests/GetAllMediaLibraryQueryParamType.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 |
| `IncludeMeta` | [GetAllMediaLibraryQueryParamIncludeMeta](../../Models/Requests/GetAllMediaLibraryQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `Type` | [GetLibrarySectionsAllQueryParamType](../../Models/Requests/GetLibrarySectionsAllQueryParamType.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 |
| `IncludeMeta` | [GetLibrarySectionsAllQueryParamIncludeMeta](../../Models/Requests/GetLibrarySectionsAllQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `IncludeGuids` | [QueryParamIncludeGuids](../../Models/Requests/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `IncludeAdvanced` | [IncludeAdvanced](../../Models/Requests/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
| `IncludeCollections` | [QueryParamIncludeCollections](../../Models/Requests/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |

4
docs/Models/Requests/GetAllMediaLibraryResponse.md → docs/Models/Requests/GetLibrarySectionsAllResponse.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryResponse
# GetLibrarySectionsAllResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetAllMediaLibraryResponseBody](../../Models/Requests/GetAllMediaLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
| `Object` | [GetLibrarySectionsAllResponseBody](../../Models/Requests/GetLibrarySectionsAllResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |

10
docs/Models/Requests/GetLibrarySectionsAllResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibrarySectionsAllResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetLibrarySectionsAllMediaContainer](../../Models/Requests/GetLibrarySectionsAllMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/Models/Requests/GetAllMediaLibraryRole.md → docs/Models/Requests/GetLibrarySectionsAllRole.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryRole
# GetLibrarySectionsAllRole
## Fields

15
docs/Models/Requests/GetLibrarySectionsAllSort.md Normal file
View File

@@ -0,0 +1,15 @@
# GetLibrarySectionsAllSort
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
| `ActiveDirection` | [GetLibrarySectionsAllActiveDirection](../../Models/Requests/GetLibrarySectionsAllActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DefaultDirection` | [GetLibrarySectionsAllDefaultDirection](../../Models/Requests/GetLibrarySectionsAllDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DescKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `FirstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `Title` | *string* | :heavy_check_mark: | N/A | Title |

58
docs/Models/Requests/GetLibrarySectionsAllStream.md Normal file
View File

@@ -0,0 +1,58 @@
# GetLibrarySectionsAllStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `StreamType` | [GetLibrarySectionsAllStreamType](../../Models/Requests/GetLibrarySectionsAllStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
| `Format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `Default` | *bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `Index` | *int* | :heavy_minus_sign: | Index of the stream. | 0 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `Language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
| `LanguageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `LanguageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
| `HeaderCompression` | *bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `DOVIBLCompatID` | *int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `DOVIBLPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `DOVIELPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `DOVILevel` | *int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `DOVIPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `DOVIProfile` | *int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `DOVIRPUPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `DOVIVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `BitDepth` | *int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `ChromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `ChromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `CodedHeight` | *int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `CodedWidth` | *int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `ClosedCaptions` | *bool* | :heavy_minus_sign: | N/A | true |
| `ColorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `ColorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `ColorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `ColorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `FrameRate` | *float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `Key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `Height` | *int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `Level` | *int* | :heavy_minus_sign: | Video level. | 150 |
| `Original` | *bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `HasScalingMatrix` | *bool* | :heavy_minus_sign: | N/A | false |
| `Profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `ScanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `EmbeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
| `RefFrames` | *int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `Width` | *int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `Selected` | *bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `Forced` | *bool* | :heavy_minus_sign: | N/A | true |
| `Channels` | *int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `AudioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `SamplingRate` | *int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `CanAutoSync` | *bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `HearingImpaired` | *bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `Dub` | *bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `Title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

2
docs/Models/Requests/GetAllMediaLibraryStreamType.md → docs/Models/Requests/GetLibrarySectionsAllStreamType.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryStreamType
# GetLibrarySectionsAllStreamType
Stream type:
- 1 = video

15
docs/Models/Requests/GetLibrarySectionsAllType.md Normal file
View File

@@ -0,0 +1,15 @@
# GetLibrarySectionsAllType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetLibrarySectionsAllFilter](../../Models/Requests/GetLibrarySectionsAllFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[GetLibrarySectionsAllSort](../../Models/Requests/GetLibrarySectionsAllSort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[GetLibrarySectionsAllField](../../Models/Requests/GetLibrarySectionsAllField.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetAllMediaLibraryUltraBlurColors.md → docs/Models/Requests/GetLibrarySectionsAllUltraBlurColors.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryUltraBlurColors
# GetLibrarySectionsAllUltraBlurColors
## Fields

2
docs/Models/Requests/GetAllMediaLibraryWriter.md → docs/Models/Requests/GetLibrarySectionsAllWriter.md
View File

@@ -1,4 +1,4 @@
# GetAllMediaLibraryWriter
# GetLibrarySectionsAllWriter
## Fields

10
docs/Models/Requests/GetMediaMetaDataCountry.md
View File

@@ -5,8 +5,8 @@ The filter query string for country media items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | N/A | 259 |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `Filter` | *string* | :heavy_minus_sign: | N/A | country=19 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `Filter` | *string* | :heavy_check_mark: | N/A | country=19 |

14
docs/Models/Requests/GetMediaMetaDataDirector.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
| `Thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
| `TagKey` | *string* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |

10
docs/Models/Requests/GetMediaMetaDataGenre.md
View File

@@ -5,8 +5,8 @@ The filter query string for similar items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `Id` | *long* | :heavy_check_mark: | N/A | 259 |
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `Tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre=19 |

6
docs/Models/Requests/GetMediaMetaDataGuids.md
View File

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

2
docs/Models/Requests/GetMediaMetaDataMetadata.md
View File

@@ -67,6 +67,7 @@ Unknown
| `LibrarySectionID` | *long* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `Guids` | List<[GetMediaMetaDataGuids](../../Models/Requests/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetMediaMetaDataMedia](../../Models/Requests/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetMediaMetaDataGenre](../../Models/Requests/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetMediaMetaDataCountry](../../Models/Requests/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | N/A | |
@@ -74,7 +75,6 @@ Unknown
| `Writer` | List<[GetMediaMetaDataWriter](../../Models/Requests/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | N/A | |
| `Producer` | List<[GetMediaMetaDataProducer](../../Models/Requests/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetMediaMetaDataRole](../../Models/Requests/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[GetMediaMetaDataGuids](../../Models/Requests/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | N/A | |
| `Ratings` | List<[Ratings](../../Models/Requests/Ratings.md)> | :heavy_minus_sign: | N/A | |
| `Similar` | List<[GetMediaMetaDataSimilar](../../Models/Requests/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | N/A | |
| `Location` | List<[GetMediaMetaDataLocation](../../Models/Requests/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | N/A | |

32
docs/Models/Requests/GetMediaMetaDataRequest.md
View File

@@ -3,19 +3,19 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `RatingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `IncludeConcerts` | *bool* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `IncludeExtras` | *bool* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `IncludeOnDeck` | *bool* | :heavy_minus_sign: | Include on-deck items. | true |
| `IncludePopularLeaves` | *bool* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `IncludePreferences` | *bool* | :heavy_minus_sign: | Include preferences information. | true |
| `IncludeReviews` | *bool* | :heavy_minus_sign: | Include reviews for the content. | true |
| `IncludeChapters` | *bool* | :heavy_minus_sign: | Include chapter details. | true |
| `IncludeStations` | *bool* | :heavy_minus_sign: | Include station data. | true |
| `IncludeExternalMedia` | *bool* | :heavy_minus_sign: | Include external media data. | true |
| `AsyncAugmentMetadata` | *bool* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `AsyncCheckFiles` | *bool* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `AsyncRefreshAnalysis` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `AsyncRefreshLocalMediaAgent` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_check_mark: | The id(s) of the library item(s) to return metadata for. Can be a single ID or comma-separated list of IDs. | 21119,21617 |
| `IncludeConcerts` | *bool* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `IncludeExtras` | *bool* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `IncludeOnDeck` | *bool* | :heavy_minus_sign: | Include on-deck items. | true |
| `IncludePopularLeaves` | *bool* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `IncludePreferences` | *bool* | :heavy_minus_sign: | Include preferences information. | true |
| `IncludeReviews` | *bool* | :heavy_minus_sign: | Include reviews for the content. | true |
| `IncludeChapters` | *bool* | :heavy_minus_sign: | Include chapter details. | true |
| `IncludeStations` | *bool* | :heavy_minus_sign: | Include station data. | true |
| `IncludeExternalMedia` | *bool* | :heavy_minus_sign: | Include external media data. | true |
| `AsyncAugmentMetadata` | *bool* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `AsyncCheckFiles` | *bool* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `AsyncRefreshAnalysis` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `AsyncRefreshLocalMediaAgent` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |

16
docs/Models/Requests/GetMediaMetaDataRole.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `Role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `Thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `Role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `TagKey` | *string* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification.<br/>NOTE: This is globally unique across all Plex Servers.<br/> | 5d77683d85719b001f3a535e |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

22
docs/Models/Requests/GetMediaMetaDataType.md
View File

@@ -1,16 +1,20 @@
# GetMediaMetaDataType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

14
docs/Models/Requests/GetMediaMetaDataWriter.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `Thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
| `TagKey` | *string* | :heavy_minus_sign: | A 24-character hexadecimal unique key associated with the writer’s tag, used for internal identification. | 5d77683d85719b001f3a535e |

20
docs/Models/Requests/GetPlaylistContentsQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

22
docs/Models/Requests/GetRecentlyAddedHubsType.md
View File

@@ -1,16 +1,20 @@
# GetRecentlyAddedHubsType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

2
docs/Models/Requests/GetRecentlyAddedMetadata.md
View File

@@ -71,6 +71,7 @@ Unknown
| `Year` | *int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `Image` | List<[GetRecentlyAddedImage](../../Models/Requests/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
| `UltraBlurColors` | [UltraBlurColors](../../Models/Requests/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[Models.Requests.Media](../../Models/Requests/Media.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[Genre](../../Models/Requests/Genre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[Country](../../Models/Requests/Country.md)> | :heavy_minus_sign: | N/A | |
@@ -81,5 +82,4 @@ Unknown
| `Rating1` | List<[Rating](../../Models/Requests/Rating.md)> | :heavy_minus_sign: | N/A | |
| `Similar` | List<[Similar](../../Models/Requests/Similar.md)> | :heavy_minus_sign: | N/A | |
| `Location` | List<[Location](../../Models/Requests/Location.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_minus_sign: | N/A | |
| `Collection` | List<[Collection](../../Models/Requests/Collection.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetSearchAllLibrariesMetadata.md
View File

@@ -13,7 +13,7 @@
| `LibrarySectionID` | *long* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `Type` | [GetSearchAllLibrariesType](../../Models/Requests/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `Type` | [GetSearchAllLibrariesType](../../Models/Requests/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `Slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `ContentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |

22
docs/Models/Requests/GetSearchAllLibrariesType.md
View File

@@ -1,16 +1,20 @@
# GetSearchAllLibrariesType
The type of media content
The type of media content in the Plex library. This can represent videos, music, or photos.
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| Name | Value |
| ------------ | ------------ |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| `Track` | track |
| `PhotoAlbum` | photoalbum |
| `Photo` | photo |
| `Collection` | collection |

20
docs/Models/Requests/GetSearchLibraryQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

10
docs/Models/Requests/GetTopWatchedContentMediaContainer.md
View File

@@ -5,9 +5,9 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 1 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | true |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `AllowSync` | *bool* | :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 |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `Metadata` | List<[GetTopWatchedContentMetadata](../../Models/Requests/GetTopWatchedContentMetadata.md)> | :heavy_minus_sign: | N/A | |

12
docs/Models/Requests/GetTopWatchedContentQueryParamIncludeGuids.md Normal file
View File

@@ -0,0 +1,12 @@
# GetTopWatchedContentQueryParamIncludeGuids
Adds the Guid object to the response
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

20
docs/Models/Requests/GetTopWatchedContentQueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

4
docs/Models/Requests/GetTopWatchedContentRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `IncludeGuids` | *long* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `Type` | [GetTopWatchedContentQueryParamType](../../Models/Requests/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 |
| `Type` | [GetTopWatchedContentQueryParamType](../../Models/Requests/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 |
| `IncludeGuids` | [GetTopWatchedContentQueryParamIncludeGuids](../../Models/Requests/GetTopWatchedContentQueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |

6
docs/Models/Requests/Guids.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |

14
docs/Models/Requests/Producer.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
| `Tag` | *string* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the producer's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `Thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the producer. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this producer. | producer=126522 |
| `Tag` | *string* | :heavy_check_mark: | The name of the producer | Amelia Knapp |
| `TagKey` | *string* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the producer's tag, used for internal identification.<br/> | 5d77683d85719b001f3a535e |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the producer. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

20
docs/Models/Requests/QueryParamType.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

10
docs/Models/Requests/Rating.md
View File

@@ -5,8 +5,8 @@ The type of rating, for example 'audience' or 'critic'.
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `Image` | *string* | :heavy_check_mark: | N/A | imdb://image.rating |
| `Value` | *double* | :heavy_check_mark: | N/A | 5.1 |
| `Type` | *string* | :heavy_check_mark: | N/A | audience |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `Image` | *string* | :heavy_check_mark: | The URL for the rating image, for example from IMDb. | imdb://image.rating |
| `Value` | *float* | :heavy_check_mark: | N/A | 5.1 |
| `Type` | *string* | :heavy_check_mark: | N/A | audience |

16
docs/Models/Requests/Role.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `Role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `Thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
| `Tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
| `TagKey` | *string* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification.<br/>NOTE: This is globally unique across all Plex Servers.<br/> | 5d77683d85719b001f3a535e |
| `Role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |

2
docs/Models/Requests/Similar.md
View File

@@ -7,6 +7,6 @@ The display tag for the similar item, typically the title.
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `Id` | *long* | :heavy_check_mark: | N/A | 259 |
| `Id` | *int* | :heavy_check_mark: | N/A | 259 |
| `Filter` | *string* | :heavy_check_mark: | N/A | similar=259 |
| `Tag` | *string* | :heavy_check_mark: | N/A | Criss Angel Mindfreak |

20
docs/Models/Requests/Type.md
View File

@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| Name | Value |
| ------------ | ------------ |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Artist` | 5 |
| `Album` | 6 |
| `Track` | 7 |
| `PhotoAlbum` | 8 |
| `Photo` | 9 |

13
docs/Models/Requests/Writer.md
View File

@@ -3,9 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `TagKey` | *string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
| `Filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
| `TagKey` | *string* | :heavy_minus_sign: | A 24-character hexadecimal unique key associated with the writer’s tag, used for internal identification. | 5d77683d85719b001f3a535e |
| `Thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |