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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2

Browse Source
This commit is contained in:
speakeasybot
2024-09-21 00:21:00 +00:00
parent 3b6806d2db
commit 4b10ba72ca
123 changed files with 1656 additions and 2081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `Protocol` | *string* | :heavy_check_mark: | N/A |
| `Address` | *string* | :heavy_check_mark: | N/A |
| `Port` | *double* | :heavy_check_mark: | N/A |
| `Uri` | *string* | :heavy_check_mark: | N/A |
| `Local` | *bool* | :heavy_check_mark: | N/A |
| `Relay` | *bool* | :heavy_check_mark: | N/A |
| `IPv6` | *bool* | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `Protocol` | [Protocol](../../Models/Requests/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
| `Port` | *int* | :heavy_check_mark: | The port used for the connection |
| `Uri` | *string* | :heavy_check_mark: | The full URI of the connection |
| `Local` | *bool* | :heavy_check_mark: | If the connection is local address |
| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct |
| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 |

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

@@ -1,11 +1,11 @@
# DefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

42
docs/Models/Requests/GetAllLibrariesDirectory.md
View File

@@ -5,24 +5,24 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | true |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Composite` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `Filters` | *bool* | :heavy_minus_sign: | N/A | true |
| `Refreshing` | *bool* | :heavy_minus_sign: | N/A | false |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `Key` | *string* | :heavy_minus_sign: | N/A | 1 |
| `Type` | *string* | :heavy_minus_sign: | N/A | movie |
| `Title` | *string* | :heavy_minus_sign: | N/A | Movies |
| `Agent` | *string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `Scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
| `Language` | *string* | :heavy_minus_sign: | N/A | en-US |
| `Uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `UpdatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `CreatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `ScannedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `Content` | *bool* | :heavy_minus_sign: | N/A | true |
| `Directory` | *bool* | :heavy_minus_sign: | N/A | true |
| `ContentChangedAt` | *int* | :heavy_minus_sign: | N/A | 3192854 |
| `Hidden` | *int* | :heavy_minus_sign: | N/A | 0 |
| `Location` | List<[Location](../../Models/Requests/Location.md)> | :heavy_minus_sign: | N/A | |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `Composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `Filters` | *bool* | :heavy_check_mark: | N/A | true |
| `Refreshing` | *bool* | :heavy_check_mark: | N/A | false |
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `Key` | *string* | :heavy_check_mark: | N/A | 1 |
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
| `Title` | *string* | :heavy_check_mark: | N/A | Movies |
| `Agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `Scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
| `Language` | *string* | :heavy_check_mark: | N/A | en-US |
| `Uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `UpdatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `CreatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `ScannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Content` | *bool* | :heavy_check_mark: | N/A | true |
| `Directory` | *bool* | :heavy_check_mark: | N/A | true |
| `ContentChangedAt` | *int* | :heavy_check_mark: | N/A | 3192854 |
| `Hidden` | *int* | :heavy_check_mark: | N/A | 0 |
| `Location` | List<[Location](../../Models/Requests/Location.md)> | :heavy_check_mark: | N/A | |

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

@@ -8,4 +8,4 @@
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
| `Directory` | List<[GetAllLibrariesDirectory](../../Models/Requests/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
| `Directory` | List<[GetAllLibrariesDirectory](../../Models/Requests/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |

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

@@ -7,4 +7,4 @@ The libraries available on the Server
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetAllLibrariesMediaContainer](../../Models/Requests/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
| `MediaContainer` | [GetAllLibrariesMediaContainer](../../Models/Requests/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |

11
docs/Models/Requests/GetLibraryItemsField.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryItemsField
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
| `Type` | *string* | :heavy_check_mark: | N/A | string |
| `SubType` | *string* | :heavy_minus_sign: | N/A | rating |

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

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

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

@@ -0,0 +1,12 @@
# GetLibraryItemsFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |

37
docs/Models/Requests/GetLibraryItemsMediaContainer.md
View File

@@ -3,21 +3,22 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 70 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | true |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | [LibrarySectionID](../../Models/Requests/LibrarySectionID.md) | :heavy_minus_sign: | N/A | |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1701731894 |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `Title1` | *string* | :heavy_minus_sign: | N/A | Movies |
| `Title2` | *string* | :heavy_minus_sign: | N/A | Recently Released |
| `ViewGroup` | *string* | :heavy_minus_sign: | N/A | movie |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65592 |
| `MixedParents` | *bool* | :heavy_minus_sign: | N/A | true |
| `Metadata` | List<[GetLibraryItemsMetadata](../../Models/Requests/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_check_mark: | N/A | 70 |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | [LibrarySectionID](../../Models/Requests/LibrarySectionID.md) | :heavy_check_mark: | N/A | |
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
| `LibrarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `Title1` | *string* | :heavy_check_mark: | N/A | Movies |
| `Title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | movie |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65592 |
| `MixedParents` | *bool* | :heavy_minus_sign: | N/A | true |
| `Metadata` | List<[GetLibraryItemsMetadata](../../Models/Requests/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `Meta` | [Meta](../../Models/Requests/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

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

@@ -5,21 +5,21 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_minus_sign: | N/A | 58683 |
| `Key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
| `Guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `RatingKey` | *string* | :heavy_check_mark: | N/A | 58683 |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `Guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `Studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `Type` | *string* | :heavy_minus_sign: | N/A | movie |
| `Title` | *string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `ContentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
| `Summary` | *string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `Rating` | *double* | :heavy_minus_sign: | N/A | 7.6 |
| `AudienceRating` | *double* | :heavy_minus_sign: | N/A | 9.2 |
| `Year` | *int* | :heavy_minus_sign: | N/A | 2022 |
| `Year` | *int* | :heavy_check_mark: | N/A | 2022 |
| `Tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `Art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `Duration` | *int* | :heavy_minus_sign: | N/A | 11558112 |
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `AddedAt` | *int* | :heavy_minus_sign: | N/A | 1680457607 |
| `UpdatedAt` | *int* | :heavy_minus_sign: | N/A | 1703239236 |
@@ -34,12 +34,13 @@
| `GrandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `GrandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `GrandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `Media` | List<[GetLibraryItemsMedia](../../Models/Requests/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetLibraryItemsMedia](../../Models/Requests/GetLibraryItemsMedia.md)> | :heavy_check_mark: | N/A | |
| `Genre` | List<[GetLibraryItemsGenre](../../Models/Requests/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetLibraryItemsCountry](../../Models/Requests/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetLibraryItemsDirector](../../Models/Requests/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetLibraryItemsWriter](../../Models/Requests/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetLibraryItemsRole](../../Models/Requests/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
| `MediaGuid` | List<[MediaGuid](../../Models/Requests/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `TitleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
| `ViewCount` | *int* | :heavy_minus_sign: | N/A | 1 |
| `LastViewedAt` | *int* | :heavy_minus_sign: | N/A | 1682752242 |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Key` | *string* | :heavy_check_mark: | N/A | = |
| `Title` | *string* | :heavy_check_mark: | N/A | is |

13
docs/Models/Requests/GetLibraryItemsSort.md Normal file
View File

@@ -0,0 +1,13 @@
# GetLibraryItemsSort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
| `DefaultDirection` | *string* | :heavy_check_mark: | N/A | 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 |

14
docs/Models/Requests/GetLibraryItemsType.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryItemsType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | show |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetLibraryItemsFilter](../../Models/Requests/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[GetLibraryItemsSort](../../Models/Requests/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[GetLibraryItemsField](../../Models/Requests/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |

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

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Strong` | *bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `ClientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
| `DeviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
| `ClientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
| `ClientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Strong` | *bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `ClientName` | *string* | :heavy_minus_sign: | N/A | Plex Web |
| `DeviceName` | *string* | :heavy_minus_sign: | N/A | Linux |
| `ClientVersion` | *string* | :heavy_minus_sign: | N/A | 4.133.0 |
| `ClientPlatform` | *string* | :heavy_minus_sign: | N/A | Chrome |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

11
docs/Models/Requests/GetServerResourcesRequest.md
View File

@@ -3,9 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

7
docs/Models/Requests/GetTokenByPinIdRequest.md
View File

@@ -3,7 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for |

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

@@ -26,7 +26,7 @@ Logged in user details
| `HomeAdmin` | *bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `HomeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `Id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `JoinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `JoinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | *bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [MailingListStatus](../../Models/Requests/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
@@ -34,7 +34,7 @@ Logged in user details
| ~~`Pin`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `Profile` | [UserProfile](../../Models/Requests/UserProfile.md) | :heavy_check_mark: | N/A | |
| `Protected` | *bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *long* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `RememberExpiresAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Restricted` | *bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | List<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -6,7 +6,7 @@ Adds the Guids object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ Include Https entries in the results
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ Include IPv6 entries in the results
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -6,7 +6,7 @@ Adds the Meta object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -7,7 +7,7 @@ E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Id` | *int* | :heavy_minus_sign: | N/A | 1 |
| `Path` | *string* | :heavy_minus_sign: | N/A | /movies |
| `Id` | *int* | :heavy_check_mark: | N/A | 1 |
| `Path` | *string* | :heavy_check_mark: | N/A | /movies |

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

@@ -0,0 +1,8 @@
# MediaGuid
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

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

@@ -1,9 +1,11 @@
# MediaReviewsVisibility
Whether or not the account has media reviews visibility enabled
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

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

52
docs/Models/Requests/PlexDevice.md
View File

@@ -3,29 +3,29 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Name` | *string* | :heavy_check_mark: | N/A |
| `Product` | *string* | :heavy_check_mark: | N/A |
| `ProductVersion` | *string* | :heavy_check_mark: | N/A |
| `Platform` | *string* | :heavy_check_mark: | N/A |
| `PlatformVersion` | *string* | :heavy_check_mark: | N/A |
| `Device` | *string* | :heavy_check_mark: | N/A |
| `ClientIdentifier` | *string* | :heavy_check_mark: | N/A |
| `CreatedAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A |
| `LastSeenAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A |
| `Provides` | *string* | :heavy_check_mark: | N/A |
| `OwnerId` | *long* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request |
| `SourceTitle` | *string* | :heavy_check_mark: | N/A |
| `PublicAddress` | *string* | :heavy_check_mark: | N/A |
| `AccessToken` | *string* | :heavy_check_mark: | N/A |
| `Owned` | *bool* | :heavy_check_mark: | N/A |
| `Home` | *bool* | :heavy_check_mark: | N/A |
| `Synced` | *bool* | :heavy_check_mark: | N/A |
| `Relay` | *bool* | :heavy_check_mark: | N/A |
| `Presence` | *bool* | :heavy_check_mark: | N/A |
| `HttpsRequired` | *bool* | :heavy_check_mark: | N/A |
| `PublicAddressMatches` | *bool* | :heavy_check_mark: | N/A |
| `DnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A |
| `NatLoopbackSupported` | *bool* | :heavy_check_mark: | N/A |
| `Connections` | List<[Connections](../../Models/Requests/Connections.md)> | :heavy_check_mark: | N/A |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Name` | *string* | :heavy_check_mark: | N/A | |
| `Product` | *string* | :heavy_check_mark: | N/A | |
| `ProductVersion` | *string* | :heavy_check_mark: | N/A | |
| `Platform` | *string* | :heavy_check_mark: | N/A | |
| `PlatformVersion` | *string* | :heavy_check_mark: | N/A | |
| `Device` | *string* | :heavy_check_mark: | N/A | |
| `ClientIdentifier` | *string* | :heavy_check_mark: | N/A | |
| `CreatedAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `LastSeenAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `Provides` | *string* | :heavy_check_mark: | N/A | |
| `OwnerId` | *long* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
| `SourceTitle` | *string* | :heavy_check_mark: | N/A | |
| `PublicAddress` | *string* | :heavy_check_mark: | N/A | |
| `AccessToken` | *string* | :heavy_check_mark: | N/A | |
| `Owned` | *bool* | :heavy_check_mark: | N/A | |
| `Home` | *bool* | :heavy_check_mark: | N/A | |
| `Synced` | *bool* | :heavy_check_mark: | N/A | |
| `Relay` | *bool* | :heavy_check_mark: | N/A | |
| `Presence` | *bool* | :heavy_check_mark: | N/A | |
| `HttpsRequired` | *bool* | :heavy_check_mark: | N/A | |
| `PublicAddressMatches` | *bool* | :heavy_check_mark: | N/A | |
| `DnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A | |
| `NatLoopbackSupported` | *bool* | :heavy_check_mark: | N/A | |
| `Connections` | List<[Connections](../../Models/Requests/Connections.md)> | :heavy_check_mark: | N/A | |

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

@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -1,11 +1,11 @@
# PostUsersSignInDataDefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -1,9 +1,11 @@
# PostUsersSignInDataMediaReviewsVisibility
Whether or not the account has media reviews visibility enabled
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -1,9 +0,0 @@
# PostUsersSignInDataRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -26,7 +26,7 @@ Returns the user account data with a valid auth token
| `HomeAdmin` | *bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `HomeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `Id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `JoinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `JoinedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | *bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [PostUsersSignInDataMailingListStatus](../../Models/Requests/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
@@ -34,7 +34,7 @@ Returns the user account data with a valid auth token
| ~~`Pin`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `Profile` | [PostUsersSignInDataUserProfile](../../Models/Requests/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `Protected` | *bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *long* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `RememberExpiresAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Restricted` | *bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | List<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |

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

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `AutoSelectSubtitle` | [PostUsersSignInDataAutoSelectSubtitle](../../Models/Requests/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `DefaultSubtitleAccessibility` | [PostUsersSignInDataDefaultSubtitleAccessibility](../../Models/Requests/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `DefaultSubtitleForced` | [PostUsersSignInDataDefaultSubtitleForced](../../Models/Requests/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `WatchedIndicator` | [PostUsersSignInDataWatchedIndicator](../../Models/Requests/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [PostUsersSignInDataMediaReviewsVisibility](../../Models/Requests/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `AutoSelectSubtitle` | [PostUsersSignInDataAutoSelectSubtitle](../../Models/Requests/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleAccessibility` | [PostUsersSignInDataDefaultSubtitleAccessibility](../../Models/Requests/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleForced` | [PostUsersSignInDataDefaultSubtitleForced](../../Models/Requests/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_minus_sign: | N/A | 1 |
| `WatchedIndicator` | [PostUsersSignInDataWatchedIndicator](../../Models/Requests/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [PostUsersSignInDataMediaReviewsVisibility](../../Models/Requests/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 1 |

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

@@ -1,9 +1,11 @@
# PostUsersSignInDataWatchedIndicator
Whether or not media watched indicators are enabled (little orange dot on media)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

11
docs/Models/Requests/Protocol.md Normal file
View File

@@ -0,0 +1,11 @@
# Protocol
The protocol used for the connection (http, https, etc)
## Values
| Name | Value |
| ------- | ------- |
| `Http` | http |
| `Https` | https |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

3
docs/Models/Requests/UploadPlaylistRequest.md
View File

@@ -6,4 +6,5 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |

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

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `AutoSelectSubtitle` | [AutoSelectSubtitle](../../Models/Requests/AutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `DefaultSubtitleAccessibility` | [DefaultSubtitleAccessibility](../../Models/Requests/DefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `DefaultSubtitleForced` | [DefaultSubtitleForced](../../Models/Requests/DefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `WatchedIndicator` | [WatchedIndicator](../../Models/Requests/WatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [MediaReviewsVisibility](../../Models/Requests/MediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `AutoSelectSubtitle` | [AutoSelectSubtitle](../../Models/Requests/AutoSelectSubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleAccessibility` | [DefaultSubtitleAccessibility](../../Models/Requests/DefaultSubtitleAccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleForced` | [DefaultSubtitleForced](../../Models/Requests/DefaultSubtitleForced.md) | :heavy_minus_sign: | N/A | 1 |
| `WatchedIndicator` | [WatchedIndicator](../../Models/Requests/WatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [MediaReviewsVisibility](../../Models/Requests/MediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 1 |

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

@@ -1,9 +1,11 @@
# WatchedIndicator
Whether or not media watched indicators are enabled (little orange dot on media)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |