LukeParke/plexgo
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexgo.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:10:16 +00:00
parent d83bd96c5f
commit f52d81d1f6
76 changed files with 1100 additions and 806 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 |
| ------------------------ | ------------------------ |
| `AutoSelectSubtitleZero` | 0 |
| `AutoSelectSubtitleOne` | 1 |
| Name | Value |
| --------------------------- | --------------------------- |
| `AutoSelectSubtitleDisable` | 0 |
| `AutoSelectSubtitleEnable` | 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` | *float64* | :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` | [operations.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` | *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/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 |
| ---------------------------------- | ---------------------------------- |
| `DefaultSubtitleAccessibilityZero` | 0 |
| `DefaultSubtitleAccessibilityOne` | 1 |
| Name | Value |
| ------------------------------------- | ------------------------------------- |
| `DefaultSubtitleAccessibilityDisable` | 0 |
| `DefaultSubtitleAccessibilityEnable` | 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 |
| --------------------------- | --------------------------- |
| `DefaultSubtitleForcedZero` | 0 |
| `DefaultSubtitleForcedOne` | 1 |
| Name | Value |
| ------------------------------ | ------------------------------ |
| `DefaultSubtitleForcedDisable` | 0 |
| `DefaultSubtitleForcedEnable` | 1 |

42
docs/models/operations/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` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `CreatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `ScannedAt` | **int64* | :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` | [][operations.Location](../../models/operations/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` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `CreatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `ScannedAt` | *int64* | :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` | [][operations.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` | *bool* | :heavy_check_mark: | N/A | false |
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
| `Directory` | [][operations.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` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [operations.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` | **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` | [][operations.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` | **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` | [*operations.LibrarySectionID](../../models/operations/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` | [][operations.GetLibraryItemsMetadata](../../models/operations/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` | [operations.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` | **int* | :heavy_minus_sign: | N/A | 65592 |
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | true |
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_minus_sign: | N/A | |
| `Meta` | [*operations.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` | **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` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
| `AudienceRating` | **float64* | :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` | [*types.Date](../../types/date.md) | :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` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | N/A | |
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_check_mark: | N/A | |
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
| `MediaGUID` | [][operations.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` | **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/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` | **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/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` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
| `Sort` | [][operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md) | :heavy_minus_sign: | N/A | |
| `Field` | [][operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md) | :heavy_minus_sign: | N/A | |

13
docs/models/operations/getpinglobals.md
View File

@@ -3,10 +3,9 @@
## 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 |
| `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 |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `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 |

15
docs/models/operations/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/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 |
| ---------------------------------------- | ---------------------------------------- |
| `GetPlaylistContentsQueryParamTypeOne` | 1 |
| `GetPlaylistContentsQueryParamTypeTwo` | 2 |
| `GetPlaylistContentsQueryParamTypeThree` | 3 |
| `GetPlaylistContentsQueryParamTypeFour` | 4 |
| Name | Value |
| ------------------------------------------ | ------------------------------------------ |
| `GetPlaylistContentsQueryParamTypeMovie` | 1 |
| `GetPlaylistContentsQueryParamTypeShow` | 2 |
| `GetPlaylistContentsQueryParamTypeSeason` | 3 |
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |

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

@@ -1,8 +0,0 @@
# GetServerResourcesGlobals
## 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 |

11
docs/models/operations/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` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `IncludeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

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

@@ -1,8 +0,0 @@
# GetTokenByPinIDGlobals
## 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 |

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

@@ -3,7 +3,6 @@
## 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 |
| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `PinID` | *int64* | :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` | **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` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `JoinedAt` | *int64* | :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` | [operations.MailingListStatus](../../models/operations/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` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
| `Protected` | **bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Restricted` | **bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | []*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 |
| ----------------------------------------- | ----------------------------------------- |
| `GetTopWatchedContentQueryParamTypeOne` | 1 |
| `GetTopWatchedContentQueryParamTypeTwo` | 2 |
| `GetTopWatchedContentQueryParamTypeThree` | 3 |
| `GetTopWatchedContentQueryParamTypeFour` | 4 |
| Name | Value |
| ------------------------------------------- | ------------------------------------------- |
| `GetTopWatchedContentQueryParamTypeMovie` | 1 |
| `GetTopWatchedContentQueryParamTypeShow` | 2 |
| `GetTopWatchedContentQueryParamTypeSeason` | 3 |
| `GetTopWatchedContentQueryParamTypeEpisode` | 4 |

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

@@ -6,7 +6,7 @@ Adds the Guids object to the response
## Values
| Name | Value |
| ------------------ | ------------------ |
| `IncludeGuidsZero` | 0 |
| `IncludeGuidsOne` | 1 |
| Name | Value |
| --------------------- | --------------------- |
| `IncludeGuidsDisable` | 0 |
| `IncludeGuidsEnable` | 1 |

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

@@ -5,7 +5,7 @@ Include Https entries in the results
## Values
| Name | Value |
| ------------------ | ------------------ |
| `IncludeHTTPSZero` | 0 |
| `IncludeHTTPSOne` | 1 |
| Name | Value |
| --------------------- | --------------------- |
| `IncludeHTTPSDisable` | 0 |
| `IncludeHTTPSEnable` | 1 |

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

@@ -5,7 +5,7 @@ Include IPv6 entries in the results
## Values
| Name | Value |
| ----------------- | ----------------- |
| `IncludeIPv6Zero` | 0 |
| `IncludeIPv6One` | 1 |
| Name | Value |
| -------------------- | -------------------- |
| `IncludeIPv6Disable` | 0 |
| `IncludeIPv6Enable` | 1 |

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

@@ -6,7 +6,7 @@ Adds the Meta object to the response
## Values
| Name | Value |
| ----------------- | ----------------- |
| `IncludeMetaZero` | 0 |
| `IncludeMetaOne` | 1 |
| Name | Value |
| -------------------- | -------------------- |
| `IncludeMetaDisable` | 0 |
| `IncludeMetaEnable` | 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 |
| ------------------ | ------------------ |
| `IncludeRelayZero` | 0 |
| `IncludeRelayOne` | 1 |
| Name | Value |
| --------------------- | --------------------- |
| `IncludeRelayDisable` | 0 |
| `IncludeRelayEnable` | 1 |

4
docs/models/operations/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/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 |
| ---------------------------- | ---------------------------- |
| `MediaReviewsVisibilityZero` | 0 |
| `MediaReviewsVisibilityOne` | 1 |
| Name | Value |
| ------------------------------- | ------------------------------- |
| `MediaReviewsVisibilityDisable` | 0 |
| `MediaReviewsVisibilityEnable` | 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` | [][operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_minus_sign: | N/A |
| `FieldType` | [][operations.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` | *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` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A |
| `LastSeenAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A |
| `Provides` | *string* | :heavy_check_mark: | N/A |
| `OwnerID` | *int64* | :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` | [][operations.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` | *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` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `LastSeenAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `Provides` | *string* | :heavy_check_mark: | N/A | |
| `OwnerID` | *int64* | :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` | [][operations.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 |
| ------------------------------------------- | ------------------------------------------- |
| `PostUsersSignInDataAutoSelectSubtitleZero` | 0 |
| `PostUsersSignInDataAutoSelectSubtitleOne` | 1 |
| Name | Value |
| ---------------------------------------------- | ---------------------------------------------- |
| `PostUsersSignInDataAutoSelectSubtitleDisable` | 0 |
| `PostUsersSignInDataAutoSelectSubtitleEnable` | 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 |
| ----------------------------------------------------- | ----------------------------------------------------- |
| `PostUsersSignInDataDefaultSubtitleAccessibilityZero` | 0 |
| `PostUsersSignInDataDefaultSubtitleAccessibilityOne` | 1 |
| Name | Value |
| -------------------------------------------------------- | -------------------------------------------------------- |
| `PostUsersSignInDataDefaultSubtitleAccessibilityDisable` | 0 |
| `PostUsersSignInDataDefaultSubtitleAccessibilityEnable` | 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 |
| ---------------------------------------------- | ---------------------------------------------- |
| `PostUsersSignInDataDefaultSubtitleForcedZero` | 0 |
| `PostUsersSignInDataDefaultSubtitleForcedOne` | 1 |
| Name | Value |
| ------------------------------------------------- | ------------------------------------------------- |
| `PostUsersSignInDataDefaultSubtitleForcedDisable` | 0 |
| `PostUsersSignInDataDefaultSubtitleForcedEnable` | 1 |

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

@@ -1,8 +0,0 @@
# PostUsersSignInDataGlobals
## 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 |

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 |
| ----------------------------------------------- | ----------------------------------------------- |
| `PostUsersSignInDataMediaReviewsVisibilityZero` | 0 |
| `PostUsersSignInDataMediaReviewsVisibilityOne` | 1 |
| Name | Value |
| -------------------------------------------------- | -------------------------------------------------- |
| `PostUsersSignInDataMediaReviewsVisibilityDisable` | 0 |
| `PostUsersSignInDataMediaReviewsVisibilityEnable` | 1 |

9
docs/models/operations/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` | [*operations.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` | **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` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `JoinedAt` | *int64* | :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` | [operations.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`~~ | **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` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
| `Protected` | **bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `RememberExpiresAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Restricted` | **bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | []*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` | **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` | [*operations.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` | [*operations.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` | [*operations.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` | [*operations.PostUsersSignInDataWatchedIndicator](../../models/operations/postuserssignindatawatchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [*operations.PostUsersSignInDataMediaReviewsVisibility](../../models/operations/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` | [*operations.PostUsersSignInDataAutoSelectSubtitle](../../models/operations/postuserssignindataautoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleAccessibility` | [*operations.PostUsersSignInDataDefaultSubtitleAccessibility](../../models/operations/postuserssignindatadefaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleForced` | [*operations.PostUsersSignInDataDefaultSubtitleForced](../../models/operations/postuserssignindatadefaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |
| `WatchedIndicator` | [*operations.PostUsersSignInDataWatchedIndicator](../../models/operations/postuserssignindatawatchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [*operations.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 |
| ----------------------------------------- | ----------------------------------------- |
| `PostUsersSignInDataWatchedIndicatorZero` | 0 |
| `PostUsersSignInDataWatchedIndicatorOne` | 1 |
| Name | Value |
| -------------------------------------------- | -------------------------------------------- |
| `PostUsersSignInDataWatchedIndicatorDisable` | 0 |
| `PostUsersSignInDataWatchedIndicatorEnable` | 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 |
| --------------- | --------------- |
| `ProtocolHTTP` | http |
| `ProtocolHTTPS` | 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 |
| --------------------- | --------------------- |
| `QueryParamTypeOne` | 1 |
| `QueryParamTypeTwo` | 2 |
| `QueryParamTypeThree` | 3 |
| `QueryParamTypeFour` | 4 |
| Name | Value |
| ----------------------- | ----------------------- |
| `QueryParamTypeMovie` | 1 |
| `QueryParamTypeShow` | 2 |
| `QueryParamTypeSeason` | 3 |
| `QueryParamTypeEpisode` | 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 |
| ----------- | ----------- |
| `TypeOne` | 1 |
| `TypeTwo` | 2 |
| `TypeThree` | 3 |
| `TypeFour` | 4 |
| Name | Value |
| ------------- | ------------- |
| `TypeMovie` | 1 |
| `TypeShow` | 2 |
| `TypeSeason` | 3 |
| `TypeEpisode` | 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` | [operations.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` | [operations.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` | *int64* | :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` | **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` | [*operations.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` | [*operations.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` | [*operations.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` | [*operations.WatchedIndicator](../../models/operations/watchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [*operations.MediaReviewsVisibility](../../models/operations/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` | [*operations.AutoSelectSubtitle](../../models/operations/autoselectsubtitle.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleAccessibility` | [*operations.DefaultSubtitleAccessibility](../../models/operations/defaultsubtitleaccessibility.md) | :heavy_minus_sign: | N/A | 1 |
| `DefaultSubtitleForced` | [*operations.DefaultSubtitleForced](../../models/operations/defaultsubtitleforced.md) | :heavy_minus_sign: | N/A | 1 |
| `WatchedIndicator` | [*operations.WatchedIndicator](../../models/operations/watchedindicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [*operations.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 |
| ---------------------- | ---------------------- |
| `WatchedIndicatorZero` | 0 |
| `WatchedIndicatorOne` | 1 |
| Name | Value |
| ------------------------- | ------------------------- |
| `WatchedIndicatorDisable` | 0 |
| `WatchedIndicatorEnable` | 1 |