LukeParke/plexjava
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjava.git synced 2025-12-07 20:47:45 +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:25:44 +00:00
parent f3780ae807
commit 3499fe6d12
190 changed files with 4636 additions and 5690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/models/operations/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/operations/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` | *boolean* | :heavy_check_mark: | N/A |
| `relay` | *boolean* | :heavy_check_mark: | N/A |
| `iPv6` | *boolean* | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `protocol` | [Protocol](../../models/operations/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` | *boolean* | :heavy_check_mark: | If the connection is local address |
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct |
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 |

10
docs/models/operations/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/operations/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/operations/GetAllLibrariesDirectory.md
View File

@@ -5,24 +5,24 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | false |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | 1 |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *Optional<String>* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *Optional<String>* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *Optional<Long>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `createdAt` | *Optional<Long>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `scannedAt` | *Optional<Long>* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `content` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `directory` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `contentChangedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 0 |
| `location` | List<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *String* | :heavy_check_mark: | N/A | 1 |
| `type` | *String* | :heavy_check_mark: | N/A | movie |
| `title` | *String* | :heavy_check_mark: | N/A | Movies |
| `agent` | *String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *String* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *String* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `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` | *boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *boolean* | :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/operations/Location.md)> | :heavy_check_mark: | N/A | |

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

@@ -8,4 +8,4 @@
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `title1` | *String* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | List<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
| `directory` | List<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |

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

@@ -5,6 +5,6 @@ The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional<GetAllLibrariesMediaContainer>](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `mediaContainer` | [GetAllLibrariesMediaContainer](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |

11
docs/models/operations/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` | *Optional<String>* | :heavy_minus_sign: | N/A | rating |

9
docs/models/operations/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/operations/GetLibraryItemsOperator.md)> | :heavy_check_mark: | N/A | |

12
docs/models/operations/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/operations/GetLibraryItemsMediaContainer.md
View File

@@ -3,21 +3,22 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `size` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 70 |
| `allowSync` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *Optional<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | [Optional<LibrarySectionID>](../../models/operations/LibrarySectionID.md) | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *Optional<String>* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *Optional<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *Optional<String>* | :heavy_minus_sign: | N/A | Movies |
| `title2` | *Optional<String>* | :heavy_minus_sign: | N/A | Recently Released |
| `viewGroup` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `viewMode` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
| `allowSync` | *boolean* | :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/operations/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` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *Optional<Boolean>* | :heavy_minus_sign: | N/A | true |
| `metadata` | List<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `meta` | [Optional<Meta>](../../models/operations/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/operations/GetLibraryItemsMetadata.md
View File

@@ -5,21 +5,21 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *Optional<String>* | :heavy_minus_sign: | N/A | 58683 |
| `key` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
| `guid` | *Optional<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` | *Optional<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `type` | *Optional<String>* | :heavy_minus_sign: | N/A | movie |
| `title` | *Optional<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` | *Optional<String>* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *Optional<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` | *Optional<Double>* | :heavy_minus_sign: | N/A | 7.6 |
| `audienceRating` | *Optional<Double>* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 2022 |
| `year` | *int* | :heavy_check_mark: | N/A | 2022 |
| `tagline` | *Optional<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `thumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `duration` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `addedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1680457607 |
| `updatedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1703239236 |
@@ -34,12 +34,13 @@
| `grandparentThumb` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `grandparentArt` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparentTheme` | *Optional<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | List<[GetLibraryItemsMedia](../../models/operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
| `media` | List<[GetLibraryItemsMedia](../../models/operations/GetLibraryItemsMedia.md)> | :heavy_check_mark: | N/A | |
| `genre` | List<[GetLibraryItemsGenre](../../models/operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | List<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | List<[GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | List<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | List<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
| `mediaGuid` | List<[MediaGuid](../../models/operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `titleSort` | *Optional<String>* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |

9
docs/models/operations/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/operations/GetLibraryItemsSort.md Normal file
View File

@@ -0,0 +1,13 @@
# GetLibraryItemsSort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `default_` | *Optional<String>* | :heavy_minus_sign: | N/A | asc |
| `defaultDirection` | *String* | :heavy_check_mark: | N/A | asc |
| `descKey` | *Optional<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *Optional<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/operations/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` | *boolean* | :heavy_check_mark: | N/A | false |
| `filter` | List<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | List<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | List<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |

15
docs/models/operations/GetPinRequest.md
View File

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *Optional<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *Optional<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` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *Optional<Boolean>* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientName` | *Optional<String>* | :heavy_minus_sign: | N/A | Plex Web |
| `deviceName` | *Optional<String>* | :heavy_minus_sign: | N/A | Linux |
| `clientVersion` | *Optional<String>* | :heavy_minus_sign: | N/A | 4.133.0 |
| `clientPlatform` | *Optional<String>* | :heavy_minus_sign: | N/A | Chrome |

12
docs/models/operations/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/operations/GetServerResourcesRequest.md
View File

@@ -3,9 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *Optional<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` | [Optional<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Optional<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Optional<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `includeHttps` | [Optional<IncludeHttps>](../../models/operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Optional<IncludeRelay>](../../models/operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Optional<IncludeIPv6>](../../models/operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

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

@@ -3,7 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *Optional<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 |
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `pinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for |

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

@@ -26,7 +26,7 @@ Logged in user details
| `homeAdmin` | *Optional<Boolean>* | :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` | *Optional<String>* | :heavy_check_mark: | The account locale | |
| `mailingListActive` | *Optional<Boolean>* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [MailingListStatus](../../models/operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
@@ -34,7 +34,7 @@ Logged in user details
| ~~`pin`~~ | *Optional<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/operations/UserProfile.md) | :heavy_check_mark: | N/A | |
| `protected_` | *Optional<Boolean>* | :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` | *Optional<Boolean>* | :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/operations/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/operations/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/operations/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/operations/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/operations/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/operations/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 |

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

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
| `id` | *Optional<Integer>* | :heavy_minus_sign: | N/A | 1 |
| `path` | *Optional<String>* | :heavy_minus_sign: | N/A | /movies |
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
| `path` | *String* | :heavy_check_mark: | N/A | /movies |

8
docs/models/operations/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/operations/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/operations/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/operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A |
| `fieldType` | List<[GetLibraryItemsFieldType](../../models/operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |

52
docs/models/operations/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` | *Optional<String>* | :heavy_check_mark: | N/A |
| `platformVersion` | *Optional<String>* | :heavy_check_mark: | N/A |
| `device` | *Optional<String>* | :heavy_check_mark: | N/A |
| `clientIdentifier` | *String* | :heavy_check_mark: | N/A |
| `createdAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A |
| `lastSeenAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A |
| `provides` | *String* | :heavy_check_mark: | N/A |
| `ownerId` | *Optional<Long>* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request |
| `sourceTitle` | *Optional<String>* | :heavy_check_mark: | N/A |
| `publicAddress` | *String* | :heavy_check_mark: | N/A |
| `accessToken` | *String* | :heavy_check_mark: | N/A |
| `owned` | *boolean* | :heavy_check_mark: | N/A |
| `home` | *boolean* | :heavy_check_mark: | N/A |
| `synced` | *boolean* | :heavy_check_mark: | N/A |
| `relay` | *boolean* | :heavy_check_mark: | N/A |
| `presence` | *boolean* | :heavy_check_mark: | N/A |
| `httpsRequired` | *boolean* | :heavy_check_mark: | N/A |
| `publicAddressMatches` | *boolean* | :heavy_check_mark: | N/A |
| `dnsRebindingProtection` | *boolean* | :heavy_check_mark: | N/A |
| `natLoopbackSupported` | *boolean* | :heavy_check_mark: | N/A |
| `connections` | List<[Connections](../../models/operations/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` | *Optional<String>* | :heavy_check_mark: | N/A | |
| `platformVersion` | *Optional<String>* | :heavy_check_mark: | N/A | |
| `device` | *Optional<String>* | :heavy_check_mark: | N/A | |
| `clientIdentifier` | *String* | :heavy_check_mark: | N/A | |
| `createdAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `lastSeenAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `provides` | *String* | :heavy_check_mark: | N/A | |
| `ownerId` | *Optional<Long>* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
| `sourceTitle` | *Optional<String>* | :heavy_check_mark: | N/A | |
| `publicAddress` | *String* | :heavy_check_mark: | N/A | |
| `accessToken` | *String* | :heavy_check_mark: | N/A | |
| `owned` | *boolean* | :heavy_check_mark: | N/A | |
| `home` | *boolean* | :heavy_check_mark: | N/A | |
| `synced` | *boolean* | :heavy_check_mark: | N/A | |
| `relay` | *boolean* | :heavy_check_mark: | N/A | |
| `presence` | *boolean* | :heavy_check_mark: | N/A | |
| `httpsRequired` | *boolean* | :heavy_check_mark: | N/A | |
| `publicAddressMatches` | *boolean* | :heavy_check_mark: | N/A | |
| `dnsRebindingProtection` | *boolean* | :heavy_check_mark: | N/A | |
| `natLoopbackSupported` | *boolean* | :heavy_check_mark: | N/A | |
| `connections` | List<[Connections](../../models/operations/Connections.md)> | :heavy_check_mark: | N/A | |

8
docs/models/operations/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/operations/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/operations/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/operations/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/operations/PostUsersSignInDataRequest.md
View File

@@ -1,9 +0,0 @@
# PostUsersSignInDataRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *Optional<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` | [Optional<PostUsersSignInDataRequestBody>](../../models/operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -26,7 +26,7 @@ Returns the user account data with a valid auth token
| `homeAdmin` | *Optional<Boolean>* | :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` | *Optional<String>* | :heavy_check_mark: | The account locale | |
| `mailingListActive` | *Optional<Boolean>* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [PostUsersSignInDataMailingListStatus](../../models/operations/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`~~ | *Optional<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/operations/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `protected_` | *Optional<Boolean>* | :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` | *Optional<Boolean>* | :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/operations/PostUsersSignInDataUserProfile.md
View File

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [Optional<PostUsersSignInDataAutoSelectSubtitle>](../../models/operations/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `defaultSubtitleAccessibility` | [Optional<PostUsersSignInDataDefaultSubtitleAccessibility>](../../models/operations/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` | [Optional<PostUsersSignInDataDefaultSubtitleForced>](../../models/operations/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` | [Optional<PostUsersSignInDataWatchedIndicator>](../../models/operations/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [Optional<PostUsersSignInDataMediaReviewsVisibility>](../../models/operations/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [Optional<PostUsersSignInDataAutoSelectSubtitle>](../../models/operations/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `defaultSubtitleAccessibility` | [Optional<PostUsersSignInDataDefaultSubtitleAccessibility>](../../models/operations/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `defaultSubtitleForced` | [Optional<PostUsersSignInDataDefaultSubtitleForced>](../../models/operations/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_minus_sign: | N/A | 1 |
| `watchedIndicator` | [Optional<PostUsersSignInDataWatchedIndicator>](../../models/operations/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [Optional<PostUsersSignInDataMediaReviewsVisibility>](../../models/operations/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 1 |

10
docs/models/operations/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/operations/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/operations/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/operations/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/operations/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/operations/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/operations/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/operations/UserProfile.md
View File

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [Optional<AutoSelectSubtitle>](../../models/operations/AutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `defaultSubtitleAccessibility` | [Optional<DefaultSubtitleAccessibility>](../../models/operations/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` | [Optional<DefaultSubtitleForced>](../../models/operations/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` | [Optional<WatchedIndicator>](../../models/operations/WatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [Optional<MediaReviewsVisibility>](../../models/operations/MediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *Optional<String>* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [Optional<AutoSelectSubtitle>](../../models/operations/AutoSelectSubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `defaultSubtitleAccessibility` | [Optional<DefaultSubtitleAccessibility>](../../models/operations/DefaultSubtitleAccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `defaultSubtitleForced` | [Optional<DefaultSubtitleForced>](../../models/operations/DefaultSubtitleForced.md) | :heavy_minus_sign: | N/A | 1 |
| `watchedIndicator` | [Optional<WatchedIndicator>](../../models/operations/WatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [Optional<MediaReviewsVisibility>](../../models/operations/MediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 1 |

10
docs/models/operations/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 |