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

regenerated with new spec

Browse Source
This commit is contained in:
Luke Hagar
2024-09-09 18:15:22 +00:00
parent e4db9f59ee
commit 3cfd677a46
678 changed files with 32760 additions and 8167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/models/components/security.md
View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `AccessToken` | *string* | :heavy_check_mark: | N/A |
| `AccessToken` | **string* | :heavy_minus_sign: | N/A |

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

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Tonight` | [*operations.Tonight](../../models/operations/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `Skip` | [*operations.Skip](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |
| `Skip` | [*operations.Skip](../../models/operations/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the `state` set to `skipped`. | 1 |

11
docs/models/operations/autoselectsubtitle.md Normal file
View File

@@ -0,0 +1,11 @@
# AutoSelectSubtitle
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
## Values
| Name | Value |
| ------------------------ | ------------------------ |
| `AutoSelectSubtitleZero` | 0 |
| `AutoSelectSubtitleOne` | 1 |

9
docs/models/operations/billing.md Normal file
View File

@@ -0,0 +1,9 @@
# Billing
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `InternalPaymentMethod` | [operations.InternalPaymentMethod](../../models/operations/internalpaymentmethod.md) | :heavy_check_mark: | N/A |
| `PaymentMethodID` | *int64* | :heavy_check_mark: | N/A |

14
docs/models/operations/connections.md Normal file
View File

@@ -0,0 +1,14 @@
# Connections
## 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 |

12
docs/models/operations/createplaylistqueryparamtype.md Normal file
View File

@@ -0,0 +1,12 @@
# CreatePlaylistQueryParamType
type of playlist to create
## Values
| Name | Value |
| ----------------------------------- | ----------------------------------- |
| `CreatePlaylistQueryParamTypeAudio` | audio |
| `CreatePlaylistQueryParamTypeVideo` | video |
| `CreatePlaylistQueryParamTypePhoto` | photo |

14
docs/models/operations/createplaylistrequest.md
View File

@@ -3,10 +3,10 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
| `Type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
| `Smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `URI` | *string* | :heavy_check_mark: | the content URI for the playlist |
| `PlayQueueID` | **float64* | :heavy_minus_sign: | the play queue to copy to a playlist |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `Title` | *string* | :heavy_check_mark: | name of the playlist |
| `Type` | [operations.CreatePlaylistQueryParamType](../../models/operations/createplaylistqueryparamtype.md) | :heavy_check_mark: | type of playlist to create |
| `Smart` | [operations.Smart](../../models/operations/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `URI` | *string* | :heavy_check_mark: | the content URI for the playlist |
| `PlayQueueID` | **float64* | :heavy_minus_sign: | the play queue to copy to a playlist |

11
docs/models/operations/defaultsubtitleaccessibility.md Normal file
View File

@@ -0,0 +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)
## Values
| Name | Value |
| ---------------------------------- | ---------------------------------- |
| `DefaultSubtitleAccessibilityZero` | 0 |
| `DefaultSubtitleAccessibilityOne` | 1 |

11
docs/models/operations/defaultsubtitleforced.md Normal file
View File

@@ -0,0 +1,11 @@
# DefaultSubtitleForced
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)
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `DefaultSubtitleForcedZero` | 0 |
| `DefaultSubtitleForcedOne` | 1 |

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

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query | 1000 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

10
docs/models/operations/feature.md Normal file
View File

@@ -0,0 +1,10 @@
# Feature
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `Key` | **string* | :heavy_minus_sign: | N/A |
| `Type` | **string* | :heavy_minus_sign: | N/A |
| `Directory` | [][operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md) | :heavy_minus_sign: | N/A |

66
docs/models/operations/features.md Normal file
View File

@@ -0,0 +1,66 @@
# Features
## Values
| Name | Value |
| --------------------------------------------- | --------------------------------------------- |
| `FeaturesAndroidDolbyVision` | Android - Dolby Vision |
| `FeaturesAndroidPiP` | Android - PiP |
| `FeaturesCuSunset` | CU Sunset |
| `FeaturesHrkEnableEur` | HRK_enable_EUR |
| `FeaturesTrebleShowFeatures` | TREBLE-show-features |
| `FeaturesAdCountdownTimer` | ad-countdown-timer |
| `FeaturesAdaptiveBitrate` | adaptive_bitrate |
| `FeaturesAmazonLoopDebug` | amazon-loop-debug |
| `FeaturesAvodAdAnalysis` | avod-ad-analysis |
| `FeaturesAvodNewMedia` | avod-new-media |
| `FeaturesBlacklistGetSignin` | blacklist_get_signin |
| `FeaturesClientRadioStations` | client-radio-stations |
| `FeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `FeaturesCollections` | collections |
| `FeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `FeaturesCommunityAccessPlexTv` | community_access_plex_tv |
| `FeaturesCompanionsSonos` | companions_sonos |
| `FeaturesCustomHomeRemoval` | custom-home-removal |
| `FeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
| `FeaturesDisableSharingFriendships` | disable_sharing_friendships |
| `FeaturesDrmSupport` | drm_support |
| `FeaturesExcludeRestrictions` | exclude restrictions |
| `FeaturesFederatedAuth` | federated-auth |
| `FeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
| `FeaturesGuidedUpgrade` | guided-upgrade |
| `FeaturesHome` | home |
| `FeaturesIncreasePasswordComplexity` | increase-password-complexity |
| `FeaturesIos14PrivacyBanner` | ios14-privacy-banner |
| `FeaturesIterableNotificationTokens` | iterable-notification-tokens |
| `FeaturesKeepPaymentMethod` | keep-payment-method |
| `FeaturesKevinBacon` | kevin-bacon |
| `FeaturesKoreaConsent` | korea-consent |
| `FeaturesLeIsrgRootX1` | le_isrg_root_x1 |
| `FeaturesLetsEncrypt` | lets_encrypt |
| `FeaturesLightningDvrPivot` | lightning-dvr-pivot |
| `FeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `FeaturesLivetv` | livetv |
| `FeaturesMetadataSearch` | metadata_search |
| `FeaturesNewPlexPassPrices` | new_plex_pass_prices |
| `FeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
| `FeaturesPhotosFavorites` | photos-favorites |
| `FeaturesPhotosMetadataEdition` | photos-metadata-edition |
| `FeaturesPmsHealth` | pms_health |
| `FeaturesRadio` | radio |
| `FeaturesRateLimitClientToken` | rate-limit-client-token |
| `FeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `FeaturesSharedServerNotification` | shared_server_notification |
| `FeaturesSharedSourceNotification` | shared_source_notification |
| `FeaturesSigninWithApple` | signin_with_apple |
| `FeaturesSpringServeAdProvider` | spring_serve_ad_provider |
| `FeaturesTranscoderCache` | transcoder_cache |
| `FeaturesTunerSharing` | tuner-sharing |
| `FeaturesTwoFactorAuthentication` | two-factor-authentication |
| `FeaturesUnsupportedtuners` | unsupportedtuners |
| `FeaturesUpgrade3ds2` | upgrade-3ds2 |
| `FeaturesVodSchema` | vod-schema |
| `FeaturesVodCloudflare` | vod_cloudflare |
| `FeaturesWatchTogetherInvite` | watch-together-invite |
| `FeaturesWebServerDashboard` | web_server_dashboard |

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

@@ -1,11 +1,12 @@
# Filter
Filters content by field and direction/equality
(Unknown if viewedAt is the only supported column)
Filter
## Values
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
| Name | Value |
| ----------------- | ----------------- |
| `FilterAll` | all |
| `FilterAvailable` | available |
| `FilterReleased` | released |

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

@@ -1,10 +1,6 @@
# Force
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
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.
Force the refresh even if the library is already being refreshed.
## Values

19
docs/models/operations/friend.md Normal file
View File

@@ -0,0 +1,19 @@
# Friend
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `Email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `FriendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
| `Home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
| `ID` | *int* | :heavy_check_mark: | The Plex account ID | |
| `Restricted` | **bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `SharedServers` | [][operations.SharedServers](../../models/operations/sharedservers.md) | :heavy_check_mark: | N/A | |
| `SharedSources` | [][operations.SharedSources](../../models/operations/sharedsources.md) | :heavy_check_mark: | N/A | |
| `Status` | [operations.Status](../../models/operations/status.md) | :heavy_check_mark: | Current friend request status | accepted |
| `Thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
| `Title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
| `Username` | *string* | :heavy_check_mark: | The account username | username123 |
| `UUID` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |

20
docs/models/operations/geodata.md Normal file
View File

@@ -0,0 +1,20 @@
# GeoData
Geo location data
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Code` | *string* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
| `ContinentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `Country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `PostalCode` | *int64* | :heavy_check_mark: | The postal code of the location. | 802 |
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `Coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

28
docs/models/operations/getalllibrariesdirectory.md Normal file
View File

@@ -0,0 +1,28 @@
# GetAllLibrariesDirectory
## Fields
| 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 | |

11
docs/models/operations/getalllibrariesmediacontainer.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `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 | |

11
docs/models/operations/getalllibrariesresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllLibrariesResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetAllLibrariesResponseBody](../../models/operations/getalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

10
docs/models/operations/getalllibrariesresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

13
docs/models/operations/getbannerimagerequest.md Normal file
View File

@@ -0,0 +1,13 @@
# GetBannerImageRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `Width` | *int64* | :heavy_check_mark: | N/A | 396 |
| `Height` | *int64* | :heavy_check_mark: | N/A | 396 |
| `MinSize` | *int64* | :heavy_check_mark: | N/A | 1 |
| `Upscale` | *int64* | :heavy_check_mark: | N/A | 1 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

12
docs/models/operations/getbannerimageresponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetBannerImageResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `ResponseStream` | *io.ReadCloser* | :heavy_minus_sign: | Successful response returning an image |
| `Headers` | map[string][]*string* | :heavy_check_mark: | N/A |

11
docs/models/operations/getcompanionsdataresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetCompanionsDataResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `ResponseBodies` | [][operations.ResponseBody](../../models/operations/responsebody.md) | :heavy_minus_sign: | Companions Data |

20
docs/models/operations/getgeodatageodata.md Normal file
View File

@@ -0,0 +1,20 @@
# GetGeoDataGeoData
Geo location data
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Code` | *string* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
| `ContinentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `Country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `PostalCode` | *int64* | :heavy_check_mark: | The postal code of the location. | 802 |
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `Coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

24
docs/models/operations/getpinresponsebody.md → docs/models/operations/getgeodataresponse.md
View File

@@ -1,21 +1,11 @@
# GetPinResponseBody
The Pin
# GetGeoDataResponse
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | **float64* | :heavy_minus_sign: | PinID for use with authentication | 1272322473 |
| `Code` | **string* | :heavy_minus_sign: | N/A | 3patfx1a78ukcbr7x0n9bl26t |
| `Product` | **string* | :heavy_minus_sign: | N/A | Plex Web |
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
| `Qr` | **string* | :heavy_minus_sign: | a link to a QR code hosted on plex.tv <br/>The QR code redirects to the relevant `plex.tv/link` authentication page<br/>Which then prompts the user for the 4 Digit Link Pin<br/> | https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t |
| `ClientIdentifier` | **string* | :heavy_minus_sign: | N/A | Postman |
| `Location` | [*operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
| `ExpiresIn` | **float64* | :heavy_minus_sign: | N/A | 1800 |
| `CreatedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
| `ExpiresAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
| `AuthToken` | **string* | :heavy_minus_sign: | N/A | |
| `NewRegistration` | **bool* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `GeoData` | [*operations.GetGeoDataGeoData](../../models/operations/getgeodatageodata.md) | :heavy_minus_sign: | Gets the geo location data of the user | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |

28
docs/models/operations/getlibrariesdirectory.md
View File

@@ -1,28 +0,0 @@
# GetLibrariesDirectory
## Fields
| 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` | **int* | :heavy_minus_sign: | N/A | 1705615634 |
| `CreatedAt` | **int* | :heavy_minus_sign: | N/A | 1654131312 |
| `ScannedAt` | **int* | :heavy_minus_sign: | N/A | 1705615584 |
| `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.GetLibrariesLocation](../../models/operations/getlibrarieslocation.md) | :heavy_minus_sign: | N/A | |

9
docs/models/operations/getlibrarieslocation.md
View File

@@ -1,9 +0,0 @@
# GetLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `ID` | **int* | :heavy_minus_sign: | N/A | 1 |
| `Path` | **string* | :heavy_minus_sign: | N/A | /movies |

11
docs/models/operations/getlibrariesmediacontainer.md
View File

@@ -1,11 +0,0 @@
# GetLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `Size` | **int* | :heavy_minus_sign: | N/A | 5 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | false |
| `Title1` | **string* | :heavy_minus_sign: | N/A | Plex Library |
| `Directory` | [][operations.GetLibrariesDirectory](../../models/operations/getlibrariesdirectory.md) | :heavy_minus_sign: | N/A | |

11
docs/models/operations/getlibrariesresponse.md
View File

@@ -1,11 +0,0 @@
# GetLibrariesResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetLibrariesResponseBody](../../models/operations/getlibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

10
docs/models/operations/getlibrariesresponsebody.md
View File

@@ -1,10 +0,0 @@
# GetLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetLibrariesMediaContainer](../../models/operations/getlibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/models/operations/getlibrarydirectory.md → docs/models/operations/getlibrarydetailsdirectory.md
View File

@@ -1,4 +1,4 @@
# GetLibraryDirectory
# GetLibraryDetailsDirectory
## Fields

2
docs/models/operations/getlibraryfilter.md → docs/models/operations/getlibrarydetailsfilter.md
View File

@@ -1,4 +1,4 @@
# GetLibraryFilter
# GetLibraryDetailsFilter
## Fields

22
docs/models/operations/getlibrarydetailsmediacontainer.md Normal file
View File

@@ -0,0 +1,22 @@
# GetLibraryDetailsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `Size` | **int* | :heavy_minus_sign: | N/A | 29 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | false |
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Content` | **string* | :heavy_minus_sign: | N/A | secondary |
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | **int* | :heavy_minus_sign: | N/A | 1 |
| `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 |
| `ViewGroup` | **string* | :heavy_minus_sign: | N/A | secondary |
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
| `Directory` | [][operations.GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md) | :heavy_minus_sign: | N/A | |
| `Type` | [][operations.GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md) | :heavy_minus_sign: | N/A | |
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |

4
docs/models/operations/getlibraryrequest.md → docs/models/operations/getlibrarydetailsrequest.md
View File

@@ -1,9 +1,9 @@
# GetLibraryRequest
# GetLibraryDetailsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionID` | *float64* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `IncludeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |

11
docs/models/operations/getlibrarydetailsresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryDetailsResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetLibraryDetailsResponseBody](../../models/operations/getlibrarydetailsresponsebody.md) | :heavy_minus_sign: | The details of the library |

10
docs/models/operations/getlibrarydetailsresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryDetailsResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetLibraryDetailsMediaContainer](../../models/operations/getlibrarydetailsmediacontainer.md) | :heavy_minus_sign: | N/A |

14
docs/models/operations/getlibrarydetailstype.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryDetailsType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
| `Filter` | [][operations.GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md) | :heavy_minus_sign: | N/A | |
| `Sort` | [][operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | N/A | |
| `Field` | [][operations.Field](../../models/operations/field.md) | :heavy_minus_sign: | N/A | |

14
docs/models/operations/getlibraryitemsrequest.md
View File

@@ -3,8 +3,12 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionID` | *any* | :heavy_check_mark: | the Id of the library to query | |
| `Tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `IncludeGuids` | [*operations.IncludeGuids](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `IncludeMeta` | [*operations.IncludeMeta](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `Type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

22
docs/models/operations/getlibrarymediacontainer.md
View File

@@ -1,22 +0,0 @@
# GetLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `Size` | **int* | :heavy_minus_sign: | N/A | 29 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | false |
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Content` | **string* | :heavy_minus_sign: | N/A | secondary |
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | **int* | :heavy_minus_sign: | N/A | 1 |
| `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 |
| `ViewGroup` | **string* | :heavy_minus_sign: | N/A | secondary |
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
| `Directory` | [][operations.GetLibraryDirectory](../../models/operations/getlibrarydirectory.md) | :heavy_minus_sign: | N/A | |
| `Type` | [][operations.GetLibraryType](../../models/operations/getlibrarytype.md) | :heavy_minus_sign: | N/A | |
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |

11
docs/models/operations/getlibraryresponse.md
View File

@@ -1,11 +0,0 @@
# GetLibraryResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetLibraryResponseBody](../../models/operations/getlibraryresponsebody.md) | :heavy_minus_sign: | The details of the library |

10
docs/models/operations/getlibraryresponsebody.md
View File

@@ -1,10 +0,0 @@
# GetLibraryResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetLibraryMediaContainer](../../models/operations/getlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

14
docs/models/operations/getlibrarytype.md
View File

@@ -1,14 +0,0 @@
# GetLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
| `Filter` | [][operations.GetLibraryFilter](../../models/operations/getlibraryfilter.md) | :heavy_minus_sign: | N/A | |
| `Sort` | [][operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | N/A | |
| `Field` | [][operations.Field](../../models/operations/field.md) | :heavy_minus_sign: | N/A | |

21
docs/models/operations/getmediaprovidersdirectory.md Normal file
View File

@@ -0,0 +1,21 @@
# GetMediaProvidersDirectory
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `HubKey` | **string* | :heavy_minus_sign: | N/A |
| `Title` | **string* | :heavy_minus_sign: | N/A |
| `Agent` | **string* | :heavy_minus_sign: | N/A |
| `Language` | **string* | :heavy_minus_sign: | N/A |
| `Refreshing` | **bool* | :heavy_minus_sign: | N/A |
| `Scanner` | **string* | :heavy_minus_sign: | N/A |
| `UUID` | **string* | :heavy_minus_sign: | N/A |
| `ID` | **string* | :heavy_minus_sign: | N/A |
| `Key` | **string* | :heavy_minus_sign: | N/A |
| `Type` | **string* | :heavy_minus_sign: | N/A |
| `Subtype` | **string* | :heavy_minus_sign: | N/A |
| `UpdatedAt` | **int64* | :heavy_minus_sign: | N/A |
| `ScannedAt` | **int64* | :heavy_minus_sign: | N/A |
| `Pivot` | [][operations.Pivot](../../models/operations/pivot.md) | :heavy_minus_sign: | N/A |

51
docs/models/operations/getmediaprovidersmediacontainer.md Normal file
View File

@@ -0,0 +1,51 @@
# GetMediaProvidersMediaContainer
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `Size` | **int64* | :heavy_minus_sign: | N/A |
| `AllowCameraUpload` | **bool* | :heavy_minus_sign: | N/A |
| `AllowChannelAccess` | **bool* | :heavy_minus_sign: | N/A |
| `AllowSharing` | **bool* | :heavy_minus_sign: | N/A |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A |
| `AllowTuners` | **bool* | :heavy_minus_sign: | N/A |
| `BackgroundProcessing` | **bool* | :heavy_minus_sign: | N/A |
| `Certificate` | **bool* | :heavy_minus_sign: | N/A |
| `CompanionProxy` | **bool* | :heavy_minus_sign: | N/A |
| `CountryCode` | **string* | :heavy_minus_sign: | N/A |
| `Diagnostics` | **string* | :heavy_minus_sign: | N/A |
| `EventStream` | **bool* | :heavy_minus_sign: | N/A |
| `FriendlyName` | **string* | :heavy_minus_sign: | N/A |
| `Livetv` | **int64* | :heavy_minus_sign: | N/A |
| `MachineIdentifier` | **string* | :heavy_minus_sign: | N/A |
| `MusicAnalysis` | **int64* | :heavy_minus_sign: | N/A |
| `MyPlex` | **bool* | :heavy_minus_sign: | N/A |
| `MyPlexMappingState` | **string* | :heavy_minus_sign: | N/A |
| `MyPlexSigninState` | **string* | :heavy_minus_sign: | N/A |
| `MyPlexSubscription` | **bool* | :heavy_minus_sign: | N/A |
| `MyPlexUsername` | **string* | :heavy_minus_sign: | N/A |
| `OfflineTranscode` | **int64* | :heavy_minus_sign: | N/A |
| `OwnerFeatures` | **string* | :heavy_minus_sign: | N/A |
| `Platform` | **string* | :heavy_minus_sign: | N/A |
| `PlatformVersion` | **string* | :heavy_minus_sign: | N/A |
| `PluginHost` | **bool* | :heavy_minus_sign: | N/A |
| `PushNotifications` | **bool* | :heavy_minus_sign: | N/A |
| `ReadOnlyLibraries` | **bool* | :heavy_minus_sign: | N/A |
| `StreamingBrainABRVersion` | **int64* | :heavy_minus_sign: | N/A |
| `StreamingBrainVersion` | **int64* | :heavy_minus_sign: | N/A |
| `Sync` | **bool* | :heavy_minus_sign: | N/A |
| `TranscoderActiveVideoSessions` | **int64* | :heavy_minus_sign: | N/A |
| `TranscoderAudio` | **bool* | :heavy_minus_sign: | N/A |
| `TranscoderLyrics` | **bool* | :heavy_minus_sign: | N/A |
| `TranscoderSubtitles` | **bool* | :heavy_minus_sign: | N/A |
| `TranscoderVideo` | **bool* | :heavy_minus_sign: | N/A |
| `TranscoderVideoBitrates` | **string* | :heavy_minus_sign: | N/A |
| `TranscoderVideoQualities` | **string* | :heavy_minus_sign: | N/A |
| `TranscoderVideoResolutions` | **string* | :heavy_minus_sign: | N/A |
| `UpdatedAt` | **int64* | :heavy_minus_sign: | N/A |
| `Updater` | **bool* | :heavy_minus_sign: | N/A |
| `Version` | **string* | :heavy_minus_sign: | N/A |
| `VoiceSearch` | **bool* | :heavy_minus_sign: | N/A |
| `MediaProvider` | [][operations.MediaProvider](../../models/operations/mediaprovider.md) | :heavy_minus_sign: | N/A |

8
docs/models/operations/getmediaprovidersrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# GetMediaProvidersRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

11
docs/models/operations/getmediaprovidersresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMediaProvidersResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetMediaProvidersResponseBody](../../models/operations/getmediaprovidersresponsebody.md) | :heavy_minus_sign: | Media providers and their features |

10
docs/models/operations/getmediaprovidersresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMediaProvidersResponseBody
Media providers and their features
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetMediaProvidersMediaContainer](../../models/operations/getmediaprovidersmediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/models/operations/getmetadatacountry.md → docs/models/operations/getmetadatabyratingkeycountry.md
View File

@@ -1,4 +1,4 @@
# GetMetadataCountry
# GetMetaDataByRatingKeyCountry
## Fields

2
docs/models/operations/getmetadatadirector.md → docs/models/operations/getmetadatabyratingkeydirector.md
View File

@@ -1,4 +1,4 @@
# GetMetadataDirector
# GetMetaDataByRatingKeyDirector
## Fields

2
docs/models/operations/getmetadatagenre.md → docs/models/operations/getmetadatabyratingkeygenre.md
View File

@@ -1,4 +1,4 @@
# GetMetadataGenre
# GetMetaDataByRatingKeyGenre
## Fields

24
docs/models/operations/getmetadatabyratingkeymedia.md Normal file
View File

@@ -0,0 +1,24 @@
# GetMetaDataByRatingKeyMedia
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `ID` | **int* | :heavy_minus_sign: | N/A | 15 |
| `Duration` | **int* | :heavy_minus_sign: | N/A | 141417 |
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 2278 |
| `Width` | **int* | :heavy_minus_sign: | N/A | 1920 |
| `Height` | **int* | :heavy_minus_sign: | N/A | 814 |
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 2.35 |
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 2 |
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | aac |
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | h264 |
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 1080 |
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
| `OptimizedForStreaming` | **int* | :heavy_minus_sign: | N/A | 0 |
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
| `Part` | [][operations.GetMetaDataByRatingKeyPart](../../models/operations/getmetadatabyratingkeypart.md) | :heavy_minus_sign: | N/A | |

16
docs/models/operations/getmetadatabyratingkeymediacontainer.md Normal file
View File

@@ -0,0 +1,16 @@
# GetMetaDataByRatingKeyMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `Size` | **int* | :heavy_minus_sign: | N/A | 1 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | **int* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Metadata` | [][operations.GetMetaDataByRatingKeyMetadata](../../models/operations/getmetadatabyratingkeymetadata.md) | :heavy_minus_sign: | N/A | |

14
docs/models/operations/getmetadatametadata.md → docs/models/operations/getmetadatabyratingkeymetadata.md
View File

@@ -1,4 +1,4 @@
# GetMetadataMetadata
# GetMetaDataByRatingKeyMetadata
## Fields
@@ -29,12 +29,12 @@
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `Media` | [][operations.GetMetadataMedia](../../models/operations/getmetadatamedia.md) | :heavy_minus_sign: | N/A | |
| `Genre` | [][operations.GetMetadataGenre](../../models/operations/getmetadatagenre.md) | :heavy_minus_sign: | N/A | |
| `Country` | [][operations.GetMetadataCountry](../../models/operations/getmetadatacountry.md) | :heavy_minus_sign: | N/A | |
| `Media` | [][operations.GetMetaDataByRatingKeyMedia](../../models/operations/getmetadatabyratingkeymedia.md) | :heavy_minus_sign: | N/A | |
| `Genre` | [][operations.GetMetaDataByRatingKeyGenre](../../models/operations/getmetadatabyratingkeygenre.md) | :heavy_minus_sign: | N/A | |
| `Country` | [][operations.GetMetaDataByRatingKeyCountry](../../models/operations/getmetadatabyratingkeycountry.md) | :heavy_minus_sign: | N/A | |
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_minus_sign: | N/A | |
| `Ratings` | [][operations.Ratings](../../models/operations/ratings.md) | :heavy_minus_sign: | N/A | |
| `Director` | [][operations.GetMetadataDirector](../../models/operations/getmetadatadirector.md) | :heavy_minus_sign: | N/A | |
| `Writer` | [][operations.GetMetadataWriter](../../models/operations/getmetadatawriter.md) | :heavy_minus_sign: | N/A | |
| `Role` | [][operations.GetMetadataRole](../../models/operations/getmetadatarole.md) | :heavy_minus_sign: | N/A | |
| `Director` | [][operations.GetMetaDataByRatingKeyDirector](../../models/operations/getmetadatabyratingkeydirector.md) | :heavy_minus_sign: | N/A | |
| `Writer` | [][operations.GetMetaDataByRatingKeyWriter](../../models/operations/getmetadatabyratingkeywriter.md) | :heavy_minus_sign: | N/A | |
| `Role` | [][operations.GetMetaDataByRatingKeyRole](../../models/operations/getmetadatabyratingkeyrole.md) | :heavy_minus_sign: | N/A | |
| `Producer` | [][operations.Producer](../../models/operations/producer.md) | :heavy_minus_sign: | N/A | |

2
docs/models/operations/getmetadatapart.md → docs/models/operations/getmetadatabyratingkeypart.md
View File

@@ -1,4 +1,4 @@
# GetMetadataPart
# GetMetaDataByRatingKeyPart
## Fields

8
docs/models/operations/getmetadatarequest.md → docs/models/operations/getmetadatabyratingkeyrequest.md
View File

@@ -1,8 +1,8 @@
# GetMetadataRequest
# GetMetaDataByRatingKeyRequest
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *float64* | :heavy_check_mark: | the id of the library item to return the children of. |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |

11
docs/models/operations/getmetadatabyratingkeyresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMetaDataByRatingKeyResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetMetaDataByRatingKeyResponseBody](../../models/operations/getmetadatabyratingkeyresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |

10
docs/models/operations/getmetadatabyratingkeyresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetMetaDataByRatingKeyResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetMetaDataByRatingKeyMediaContainer](../../models/operations/getmetadatabyratingkeymediacontainer.md) | :heavy_minus_sign: | N/A |

2
docs/models/operations/getmetadatarole.md → docs/models/operations/getmetadatabyratingkeyrole.md
View File

@@ -1,4 +1,4 @@
# GetMetadataRole
# GetMetaDataByRatingKeyRole
## Fields

2
docs/models/operations/getmetadatawriter.md → docs/models/operations/getmetadatabyratingkeywriter.md
View File

@@ -1,4 +1,4 @@
# GetMetadataWriter
# GetMetaDataByRatingKeyWriter
## Fields

24
docs/models/operations/getmetadatamedia.md
View File

@@ -1,24 +0,0 @@
# GetMetadataMedia
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `ID` | **int* | :heavy_minus_sign: | N/A | 15 |
| `Duration` | **int* | :heavy_minus_sign: | N/A | 141417 |
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 2278 |
| `Width` | **int* | :heavy_minus_sign: | N/A | 1920 |
| `Height` | **int* | :heavy_minus_sign: | N/A | 814 |
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 2.35 |
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 2 |
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | aac |
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | h264 |
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 1080 |
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
| `OptimizedForStreaming` | **int* | :heavy_minus_sign: | N/A | 0 |
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | lc |
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
| `Part` | [][operations.GetMetadataPart](../../models/operations/getmetadatapart.md) | :heavy_minus_sign: | N/A | |

16
docs/models/operations/getmetadatamediacontainer.md
View File

@@ -1,16 +0,0 @@
# GetMetadataMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `Size` | **int* | :heavy_minus_sign: | N/A | 1 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | **int* | :heavy_minus_sign: | N/A | 1 |
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | cfc899d7-3000-46f6-8489-b9592714ada5 |
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Metadata` | [][operations.GetMetadataMetadata](../../models/operations/getmetadatametadata.md) | :heavy_minus_sign: | N/A | |

11
docs/models/operations/getmetadataresponse.md
View File

@@ -1,11 +0,0 @@
# GetMetadataResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetMetadataResponseBody](../../models/operations/getmetadataresponsebody.md) | :heavy_minus_sign: | The metadata of the library item. |

10
docs/models/operations/getmetadataresponsebody.md
View File

@@ -1,10 +0,0 @@
# GetMetadataResponseBody
The metadata of the library item.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetMetadataMediaContainer](../../models/operations/getmetadatamediacontainer.md) | :heavy_minus_sign: | N/A |

21
docs/models/operations/getpinauthpincontainer.md Normal file
View File

@@ -0,0 +1,21 @@
# GetPinAuthPinContainer
Requests a new pin id used in the authentication flow
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
| `Code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
| `Product` | *string* | :heavy_check_mark: | N/A | 0 |
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
| `Qr` | *string* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `ClientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | |
| `Location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `ExpiresIn` | **int64* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `ExpiresAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `AuthToken` | *any* | :heavy_minus_sign: | N/A | |
| `NewRegistration` | *any* | :heavy_minus_sign: | N/A | |

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | **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/> | Postman |
| `XPlexClientIdentifier` | **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 |

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

@@ -6,5 +6,5 @@
| 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/> | |
| `XPlexClientIdentifier` | **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/> | Postman |
| `XPlexProduct` | *string* | :heavy_check_mark: | Product name of the application shown in the list of devices<br/> | Postman |
| `XPlexClientIdentifier` | **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 |
| `XPlexProduct` | **string* | :heavy_minus_sign: | N/A | Plex Web |

12
docs/models/operations/getpinresponse.md
View File

@@ -3,9 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetPinResponseBody](../../models/operations/getpinresponsebody.md) | :heavy_minus_sign: | The Pin |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `AuthPinContainer` | [*operations.GetPinAuthPinContainer](../../models/operations/getpinauthpincontainer.md) | :heavy_minus_sign: | Requests a new pin id used in the authentication flow | {<br/>"id": 308667304,<br/>"code": "7RQZ",<br/>"product": "0",<br/>"trusted": false,<br/>"qr": "https://plex.tv/api/v2/pins/qr/7RQZ",<br/>"clientIdentifier": "string",<br/>"location": {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>},<br/>"expiresIn": 876,<br/>"createdAt": "2024-07-16T17:03:05Z",<br/>"expiresAt": "2024-07-16T17:18:05Z",<br/>"authToken": null,<br/>"newRegistration": null<br/>} |

19
docs/models/operations/getplaylistcontentsqueryparamtype.md Normal file
View File

@@ -0,0 +1,19 @@
# GetPlaylistContentsQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ---------------------------------------- | ---------------------------------------- |
| `GetPlaylistContentsQueryParamTypeOne` | 1 |
| `GetPlaylistContentsQueryParamTypeTwo` | 2 |
| `GetPlaylistContentsQueryParamTypeThree` | 3 |
| `GetPlaylistContentsQueryParamTypeFour` | 4 |

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

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist |
| `Type` | *float64* | :heavy_check_mark: | the metadata type of the item to return |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PlaylistID` | *float64* | :heavy_check_mark: | the ID of the playlist | |
| `Type` | [operations.GetPlaylistContentsQueryParamType](../../models/operations/getplaylistcontentsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

9
docs/models/operations/getrecentlyaddedrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetRecentlyAddedRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

9
docs/models/operations/getrefreshlibrarymetadatarequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetRefreshLibraryMetadataRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Force` | [*operations.Force](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |

2
docs/models/operations/refreshlibraryresponse.md → docs/models/operations/getrefreshlibrarymetadataresponse.md
View File

@@ -1,4 +1,4 @@
# RefreshLibraryResponse
# GetRefreshLibraryMetadataResponse
## Fields

20
docs/models/operations/getsearchlibrarymediacontainer.md Normal file
View File

@@ -0,0 +1,20 @@
# GetSearchLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `Size` | **int* | :heavy_minus_sign: | N/A | 2 |
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | false |
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/show-fanart.jpg |
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1698860922 |
| `Nocache` | **bool* | :heavy_minus_sign: | N/A | true |
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/show.png |
| `Title1` | **string* | :heavy_minus_sign: | N/A | TV Shows |
| `Title2` | **string* | :heavy_minus_sign: | N/A | Search for '' |
| `ViewGroup` | **string* | :heavy_minus_sign: | N/A | season |
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65593 |
| `Metadata` | [][operations.GetSearchLibraryMetadata](../../models/operations/getsearchlibrarymetadata.md) | :heavy_minus_sign: | N/A | |

2
docs/models/operations/searchlibrarymetadata.md → docs/models/operations/getsearchlibrarymetadata.md
View File

@@ -1,4 +1,4 @@
# SearchLibraryMetadata
# GetSearchLibraryMetadata
## Fields

9
docs/models/operations/getsearchlibraryrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetSearchLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Type` | [operations.QueryParamType](../../models/operations/queryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

11
docs/models/operations/getsearchlibraryresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchLibraryResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetSearchLibraryResponseBody](../../models/operations/getsearchlibraryresponsebody.md) | :heavy_minus_sign: | The contents of the library by section and type |

10
docs/models/operations/getsearchlibraryresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetSearchLibraryResponseBody
The contents of the library by section and type
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [*operations.GetSearchLibraryMediaContainer](../../models/operations/getsearchlibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,8 @@
# GetServerResourcesGlobals
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | **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 |

12
docs/models/operations/getserverresourcesrequest.md Normal file
View File

@@ -0,0 +1,12 @@
# GetServerResourcesRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | **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 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `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 |

11
docs/models/operations/getserverresourcesresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetServerResourcesResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `PlexDevices` | [][operations.PlexDevice](../../models/operations/plexdevice.md) | :heavy_minus_sign: | List of Plex Devices. This includes Plex hosted servers and clients |

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

@@ -7,5 +7,5 @@
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Sort` | **string* | :heavy_minus_sign: | Sorts the results by the specified field followed by the direction (asc, desc)<br/> | |
| `AccountID` | **int64* | :heavy_minus_sign: | Filter results by those that are related to a specific users id<br/> | 1 |
| `Filter` | [*operations.Filter](../../models/operations/filter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `Filter` | [*operations.QueryParamFilter](../../models/operations/queryparamfilter.md) | :heavy_minus_sign: | Filters content by field and direction/equality<br/>(Unknown if viewedAt is the only supported column)<br/> | {<br/>"viewed-at-greater-than": {<br/>"value": "viewedAt\u003e"<br/>},<br/>"viewed-at-greater-than-or-equal-to": {<br/>"value": "viewedAt\u003e=\u003e"<br/>},<br/>"viewed-at-less-than": {<br/>"value": "viewedAt\u003c"<br/>}<br/>} |
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | Filters the results based on the id of a valid library section<br/> | 12 |

13
docs/models/operations/getthumbimagerequest.md Normal file
View File

@@ -0,0 +1,13 @@
# GetThumbImageRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `RatingKey` | *int64* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
| `Width` | *int64* | :heavy_check_mark: | N/A | 396 |
| `Height` | *int64* | :heavy_check_mark: | N/A | 396 |
| `MinSize` | *int64* | :heavy_check_mark: | N/A | 1 |
| `Upscale` | *int64* | :heavy_check_mark: | N/A | 1 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

12
docs/models/operations/getthumbimageresponse.md Normal file
View File

@@ -0,0 +1,12 @@
# GetThumbImageResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `ResponseStream` | *io.ReadCloser* | :heavy_minus_sign: | Successful response returning an image |
| `Headers` | map[string][]*string* | :heavy_check_mark: | N/A |

21
docs/models/operations/gettokenbypinidauthpincontainer.md Normal file
View File

@@ -0,0 +1,21 @@
# GetTokenByPinIDAuthPinContainer
The Pin with a non-null authToken when it has been verified by the user
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | *int64* | :heavy_check_mark: | N/A | 308667304 |
| `Code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
| `Product` | *string* | :heavy_check_mark: | N/A | 0 |
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
| `Qr` | *string* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `ClientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | |
| `Location` | [operations.GetTokenByPinIDGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `ExpiresIn` | **int64* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `ExpiresAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `AuthToken` | *any* | :heavy_minus_sign: | N/A | |
| `NewRegistration` | *any* | :heavy_minus_sign: | N/A | |

20
docs/models/operations/gettokenbypinidgeodata.md Normal file
View File

@@ -0,0 +1,20 @@
# GetTokenByPinIDGeoData
Geo location data
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Code` | *string* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of the country. | VI |
| `ContinentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `Country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `City` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `TimeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `PostalCode` | *int64* | :heavy_check_mark: | The postal code of the location. | 802 |
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `InPrivacyRestrictedRegion` | **bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `Subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `Coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

4
docs/models/operations/gettokenglobals.md → docs/models/operations/gettokenbypinidglobals.md
View File

@@ -1,8 +1,8 @@
# GetTokenGlobals
# GetTokenByPinIDGlobals
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | **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/> | Postman |
| `XPlexClientIdentifier` | **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 |

6
docs/models/operations/gettokenrequest.md → docs/models/operations/gettokenbypinidrequest.md
View File

@@ -1,9 +1,9 @@
# GetTokenRequest
# GetTokenByPinIDRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `XPlexClientIdentifier` | **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/> | Postman |
| `XPlexClientIdentifier` | **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 | |

11
docs/models/operations/gettokenbypinidresponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetTokenByPinIDResponse
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `AuthPinContainer` | [*operations.GetTokenByPinIDAuthPinContainer](../../models/operations/gettokenbypinidauthpincontainer.md) | :heavy_minus_sign: | The Pin with a non-null authToken when it has been verified by the user | {<br/>"id": 308667304,<br/>"code": "7RQZ",<br/>"product": "0",<br/>"trusted": false,<br/>"qr": "https://plex.tv/api/v2/pins/qr/7RQZ",<br/>"clientIdentifier": "string",<br/>"location": {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>},<br/>"expiresIn": 876,<br/>"createdAt": "2024-07-16T17:03:05Z",<br/>"expiresAt": "2024-07-16T17:18:05Z",<br/>"authToken": null,<br/>"newRegistration": null<br/>} |

17
docs/models/operations/gettokenlocation.md
View File

@@ -1,17 +0,0 @@
# GetTokenLocation
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `Code` | **string* | :heavy_minus_sign: | N/A | US |
| `EuropeanUnionMember` | **bool* | :heavy_minus_sign: | N/A | |
| `ContinentCode` | **string* | :heavy_minus_sign: | N/A | NA |
| `Country` | **string* | :heavy_minus_sign: | N/A | United States |
| `City` | **string* | :heavy_minus_sign: | N/A | Austin |
| `TimeZone` | **string* | :heavy_minus_sign: | N/A | America/Chicago |
| `PostalCode` | **string* | :heavy_minus_sign: | N/A | 78732 |
| `InPrivacyRestrictedCountry` | **bool* | :heavy_minus_sign: | N/A | |
| `Subdivisions` | **string* | :heavy_minus_sign: | N/A | Texas |
| `Coordinates` | **string* | :heavy_minus_sign: | N/A | 30.3768 -97.8935 |

11
docs/models/operations/gettokenresponse.md
View File

@@ -1,11 +0,0 @@
# GetTokenResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [*operations.GetTokenResponseBody](../../models/operations/gettokenresponsebody.md) | :heavy_minus_sign: | Access Token |

21
docs/models/operations/gettokenresponsebody.md
View File

@@ -1,21 +0,0 @@
# GetTokenResponseBody
Access Token
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | **float64* | :heavy_minus_sign: | PinID for use with authentication | 1272322473 |
| `Code` | **string* | :heavy_minus_sign: | N/A | 3patfx1a78ukcbr7x0n9bl26t |
| `Product` | **string* | :heavy_minus_sign: | N/A | Plex Web |
| `Trusted` | **bool* | :heavy_minus_sign: | N/A | |
| `Qr` | **string* | :heavy_minus_sign: | a link to a QR code hosted on plex.tv <br/>The QR code redirects to the relevant `plex.tv/link` authentication page<br/>Which then prompts the user for the 4 Digit Link Pin<br/> | https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t |
| `ClientIdentifier` | **string* | :heavy_minus_sign: | N/A | Postman |
| `Location` | [*operations.GetTokenLocation](../../models/operations/gettokenlocation.md) | :heavy_minus_sign: | N/A | |
| `ExpiresIn` | **float64* | :heavy_minus_sign: | N/A | 1800 |
| `CreatedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-04-12 17:00:03 +0000 UTC |
| `ExpiresAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-04-12 17:30:03 +0000 UTC |
| `AuthToken` | **string* | :heavy_minus_sign: | N/A | |
| `NewRegistration` | **string* | :heavy_minus_sign: | N/A | |

19
docs/models/operations/gettopwatchedcontentqueryparamtype.md Normal file
View File

@@ -0,0 +1,19 @@
# GetTopWatchedContentQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| ----------------------------------------- | ----------------------------------------- |
| `GetTopWatchedContentQueryParamTypeOne` | 1 |
| `GetTopWatchedContentQueryParamTypeTwo` | 2 |
| `GetTopWatchedContentQueryParamTypeThree` | 3 |
| `GetTopWatchedContentQueryParamTypeFour` | 4 |

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

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `Type` | *int64* | :heavy_check_mark: | the library type (1 - movies, 2 - shows, 3 - music) | |
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |

11
docs/models/operations/getuserdetailsauthenticationresponsestatus.md Normal file
View File

@@ -0,0 +1,11 @@
# GetUserDetailsAuthenticationResponseStatus
String representation of subscriptionActive
## Values
| Name | Value |
| ---------------------------------------------------- | ---------------------------------------------------- |
| `GetUserDetailsAuthenticationResponseStatusInactive` | Inactive |
| `GetUserDetailsAuthenticationResponseStatusActive` | Active |

11
docs/models/operations/getuserdetailsauthenticationstatus.md Normal file
View File

@@ -0,0 +1,11 @@
# GetUserDetailsAuthenticationStatus
String representation of subscriptionActive
## Values
| Name | Value |
| -------------------------------------------- | -------------------------------------------- |
| `GetUserDetailsAuthenticationStatusInactive` | Inactive |
| `GetUserDetailsAuthenticationStatusActive` | Active |

66
docs/models/operations/getuserdetailsfeatures.md Normal file
View File

@@ -0,0 +1,66 @@
# GetUserDetailsFeatures
## Values
| Name | Value |
| ----------------------------------------------------------- | ----------------------------------------------------------- |
| `GetUserDetailsFeaturesAndroidDolbyVision` | Android - Dolby Vision |
| `GetUserDetailsFeaturesAndroidPiP` | Android - PiP |
| `GetUserDetailsFeaturesCuSunset` | CU Sunset |
| `GetUserDetailsFeaturesHrkEnableEur` | HRK_enable_EUR |
| `GetUserDetailsFeaturesTrebleShowFeatures` | TREBLE-show-features |
| `GetUserDetailsFeaturesAdCountdownTimer` | ad-countdown-timer |
| `GetUserDetailsFeaturesAdaptiveBitrate` | adaptive_bitrate |
| `GetUserDetailsFeaturesAmazonLoopDebug` | amazon-loop-debug |
| `GetUserDetailsFeaturesAvodAdAnalysis` | avod-ad-analysis |
| `GetUserDetailsFeaturesAvodNewMedia` | avod-new-media |
| `GetUserDetailsFeaturesBlacklistGetSignin` | blacklist_get_signin |
| `GetUserDetailsFeaturesClientRadioStations` | client-radio-stations |
| `GetUserDetailsFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `GetUserDetailsFeaturesCollections` | collections |
| `GetUserDetailsFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `GetUserDetailsFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
| `GetUserDetailsFeaturesCompanionsSonos` | companions_sonos |
| `GetUserDetailsFeaturesCustomHomeRemoval` | custom-home-removal |
| `GetUserDetailsFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
| `GetUserDetailsFeaturesDisableSharingFriendships` | disable_sharing_friendships |
| `GetUserDetailsFeaturesDrmSupport` | drm_support |
| `GetUserDetailsFeaturesExcludeRestrictions` | exclude restrictions |
| `GetUserDetailsFeaturesFederatedAuth` | federated-auth |
| `GetUserDetailsFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
| `GetUserDetailsFeaturesGuidedUpgrade` | guided-upgrade |
| `GetUserDetailsFeaturesHome` | home |
| `GetUserDetailsFeaturesIncreasePasswordComplexity` | increase-password-complexity |
| `GetUserDetailsFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
| `GetUserDetailsFeaturesIterableNotificationTokens` | iterable-notification-tokens |
| `GetUserDetailsFeaturesKeepPaymentMethod` | keep-payment-method |
| `GetUserDetailsFeaturesKevinBacon` | kevin-bacon |
| `GetUserDetailsFeaturesKoreaConsent` | korea-consent |
| `GetUserDetailsFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
| `GetUserDetailsFeaturesLetsEncrypt` | lets_encrypt |
| `GetUserDetailsFeaturesLightningDvrPivot` | lightning-dvr-pivot |
| `GetUserDetailsFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `GetUserDetailsFeaturesLivetv` | livetv |
| `GetUserDetailsFeaturesMetadataSearch` | metadata_search |
| `GetUserDetailsFeaturesNewPlexPassPrices` | new_plex_pass_prices |
| `GetUserDetailsFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
| `GetUserDetailsFeaturesPhotosFavorites` | photos-favorites |
| `GetUserDetailsFeaturesPhotosMetadataEdition` | photos-metadata-edition |
| `GetUserDetailsFeaturesPmsHealth` | pms_health |
| `GetUserDetailsFeaturesRadio` | radio |
| `GetUserDetailsFeaturesRateLimitClientToken` | rate-limit-client-token |
| `GetUserDetailsFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `GetUserDetailsFeaturesSharedServerNotification` | shared_server_notification |
| `GetUserDetailsFeaturesSharedSourceNotification` | shared_source_notification |
| `GetUserDetailsFeaturesSigninWithApple` | signin_with_apple |
| `GetUserDetailsFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
| `GetUserDetailsFeaturesTranscoderCache` | transcoder_cache |
| `GetUserDetailsFeaturesTunerSharing` | tuner-sharing |
| `GetUserDetailsFeaturesTwoFactorAuthentication` | two-factor-authentication |
| `GetUserDetailsFeaturesUnsupportedtuners` | unsupportedtuners |
| `GetUserDetailsFeaturesUpgrade3ds2` | upgrade-3ds2 |
| `GetUserDetailsFeaturesVodSchema` | vod-schema |
| `GetUserDetailsFeaturesVodCloudflare` | vod_cloudflare |
| `GetUserDetailsFeaturesWatchTogetherInvite` | watch-together-invite |
| `GetUserDetailsFeaturesWebServerDashboard` | web_server_dashboard |

8
docs/models/operations/getuserdetailsrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# GetUserDetailsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |

11
docs/models/operations/getuserdetailsresponse.md Normal file
View File

File diff suppressed because one or more lines are too long

9
docs/models/operations/getuserdetailsstatus.md Normal file
View File

@@ -0,0 +1,9 @@
# GetUserDetailsStatus
## Values
| Name | Value |
| ----------------------------- | ----------------------------- |
| `GetUserDetailsStatusOnline` | online |
| `GetUserDetailsStatusOffline` | offline |

13
docs/models/operations/getuserdetailssubscription.md Normal file
View File

@@ -0,0 +1,13 @@
# GetUserDetailsSubscription
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `Features` | [][operations.GetUserDetailsFeatures](../../models/operations/getuserdetailsfeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [*operations.GetUserDetailsAuthenticationResponseStatus](../../models/operations/getuserdetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | **string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | **string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

Some files were not shown because too many files have changed in this diff Show More