## Csharp SDK Changes Detected:

* `PlexApi.Butler.StartTask()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `PlexApi.Butler.StopTask()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `PlexApi.Updater.ApplyUpdates()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `error` **Changed** **Breaking** ⚠️
* `PlexApi.General.GetServerInfo()`: **Added**
* `PlexApi.General.GetIdentity()`: **Added**
* `PlexApi.General.GetSourceConnectionInformation()`: **Added**
* `PlexApi.General.GetTransientToken()`: **Added**
* `PlexApi.Events.GetNotifications()`: **Added**
* `PlexApi.Events.ConnectWebSocket()`: **Added**
* `PlexApi.Preferences.GetAllPreferences()`: **Added**
* `PlexApi.Preferences.SetPreferences()`: **Added**
* `PlexApi.Preferences.GetPreference()`: **Added**
* `PlexApi.Rate.SetRating()`: **Added**
* `PlexApi.Timeline.MarkPlayed()`: **Added**
* `PlexApi.Timeline.Report()`: **Added**
* `PlexApi.Timeline.Unscrobble()`: **Added**
* `PlexApi.Activities.ListActivities()`: **Added**
* `PlexApi.Activities.CancelActivity()`: **Added**
* `PlexApi.Butler.StopTasks()`: **Added**
* `PlexApi.Butler.GetTasks()`: **Added**
* `PlexApi.Butler.StartTasks()`: **Added**
* `PlexApi.DownloadQueue.CreateDownloadQueue()`: **Added**
* `PlexApi.DownloadQueue.GetDownloadQueue()`: **Added**
* `PlexApi.DownloadQueue.AddDownloadQueueItems()`: **Added**
* `PlexApi.DownloadQueue.ListDownloadQueueItems()`: **Added**
* `PlexApi.DownloadQueue.GetItemDecision()`: **Added**
* `PlexApi.DownloadQueue.GetDownloadQueueMedia()`: **Added**
* `PlexApi.DownloadQueue.RemoveDownloadQueueItems()`: **Added**
* `PlexApi.DownloadQueue.GetDownloadQueueItems()`: **Added**
* `PlexApi.DownloadQueue.RestartProcessingDownloadQueueItems()`: **Added**
* `PlexApi.Hubs.GetAllHubs()`: **Added**
* `PlexApi.Hubs.GetContinueWatching()`: **Added**
* `PlexApi.Hubs.GetHubItems()`: **Added**
* `PlexApi.Hubs.GetPromotedHubs()`: **Added**
* `PlexApi.Hubs.GetMetadataHubs()`: **Added**
* `PlexApi.Hubs.GetPostplayHubs()`: **Added**
* `PlexApi.Hubs.GetRelatedHubs()`: **Added**
* `PlexApi.Hubs.GetSectionHubs()`: **Added**
* `PlexApi.Hubs.ResetSectionDefaults()`: **Added**
* `PlexApi.Hubs.ListHubs()`: **Added**
* `PlexApi.Hubs.CreateCustomHub()`: **Added**
* `PlexApi.Hubs.MoveHub()`: **Added**
* `PlexApi.Hubs.DeleteCustomHub()`: **Added**
* `PlexApi.Hubs.UpdateHubVisibility()`: **Added**
* `PlexApi.Search.SearchHubs()`: **Added**
* `PlexApi.Search.VoiceSearchHubs()`: **Added**
* `PlexApi.Library.GetLibraryItems()`: **Added**
* `PlexApi.Library.DeleteCaches()`: **Added**
* `PlexApi.Library.CleanBundles()`: **Added**
* `PlexApi.Library.IngestTransientItem()`: **Added**
* `PlexApi.Library.GetLibraryMatches()`: **Added**
* `PlexApi.Library.OptimizeDatabase()`: **Added**
* `PlexApi.Library.GetRandomArtwork()`: **Added**
* `PlexApi.Library.GetSections()`: **Added**
* `PlexApi.Library.AddSection()`: **Added**
* `PlexApi.Library.StopAllRefreshes()`: **Added**
* `PlexApi.Library.GetSectionsPrefs()`: **Added**
* `PlexApi.Library.RefreshSectionsMetadata()`: **Added**
* `PlexApi.Library.GetTags()`: **Added**
* `PlexApi.Library.DeleteMetadataItem()`: **Added**
* `PlexApi.Library.EditMetadataItem()`: **Added**
* `PlexApi.Library.DetectAds()`: **Added**
* `PlexApi.Library.GetAllItemLeaves()`: **Added**
* `PlexApi.Library.AnalyzeMetadata()`: **Added**
* `PlexApi.Library.GenerateThumbs()`: **Added**
* `PlexApi.Library.DetectCredits()`: **Added**
* `PlexApi.Library.GetExtras()`: **Added**
* `PlexApi.Library.AddExtras()`: **Added**
* `PlexApi.Library.GetFile()`: **Added**
* `PlexApi.Library.StartBifGeneration()`: **Added**
* `PlexApi.Library.DetectIntros()`: **Added**
* `PlexApi.Library.CreateMarker()`: **Added**
* `PlexApi.Library.MatchItem()`: **Added**
* `PlexApi.Library.ListMatches()`: **Added**
* `PlexApi.Library.MergeItems()`: **Added**
* `PlexApi.Library.ListSonicallySimilar()`: **Added**
* `PlexApi.Library.SetItemPreferences()`: **Added**
* `PlexApi.Library.RefreshItemsMetadata()`: **Added**
* `PlexApi.Library.GetRelatedItems()`: **Added**
* `PlexApi.Library.ListSimilar()`: **Added**
* `PlexApi.Library.SplitItem()`: **Added**
* `PlexApi.Library.AddSubtitles()`: **Added**
* `PlexApi.Library.GetItemTree()`: **Added**
* `PlexApi.Library.Unmatch()`: **Added**
* `PlexApi.Library.ListTopUsers()`: **Added**
* `PlexApi.Library.DetectVoiceActivity()`: **Added**
* `PlexApi.Library.GetAugmentationStatus()`: **Added**
* `PlexApi.Library.SetStreamSelection()`: **Added**
* `PlexApi.Library.GetPerson()`: **Added**
* `PlexApi.Library.ListPersonMedia()`: **Added**
* `PlexApi.Library.DeleteLibrarySection()`: **Added**
* `PlexApi.Library.GetLibraryDetails()`: **Added**
* `PlexApi.Library.EditSection()`: **Added**
* `PlexApi.Library.UpdateItems()`: **Added**
* `PlexApi.Library.StartAnalysis()`: **Added**
* `PlexApi.Library.Autocomplete()`: **Added**
* `PlexApi.Library.GetCollections()`: **Added**
* `PlexApi.Library.GetCommon()`: **Added**
* `PlexApi.Library.EmptyTrash()`: **Added**
* `PlexApi.Library.GetSectionFilters()`: **Added**
* `PlexApi.Library.GetFirstCharacters()`: **Added**
* `PlexApi.Library.DeleteIndexes()`: **Added**
* `PlexApi.Library.DeleteIntros()`: **Added**
* `PlexApi.Library.GetSectionPreferences()`: **Added**
* `PlexApi.Library.SetSectionPreferences()`: **Added**
* `PlexApi.Library.CancelRefresh()`: **Added**
* `PlexApi.Library.RefreshSection()`: **Added**
* `PlexApi.Library.GetAvailableSorts()`: **Added**
* `PlexApi.Library.GetStreamLevels()`: **Added**
* `PlexApi.Library.GetStreamLoudness()`: **Added**
* `PlexApi.Library.GetChapterImage()`: **Added**
* `PlexApi.Library.SetItemArtwork()`: **Added**
* `PlexApi.Library.UpdateItemArtwork()`: **Added**
* `PlexApi.Library.DeleteMarker()`: **Added**
* `PlexApi.Library.EditMarker()`: **Added**
* `PlexApi.Library.DeleteMediaItem()`: **Added**
* `PlexApi.Library.GetPartIndex()`: **Added**
* `PlexApi.Library.DeleteCollection()`: **Added**
* `PlexApi.Library.GetSectionImage()`: **Added**
* `PlexApi.Library.DeleteStream()`: **Added**
* `PlexApi.Library.GetStream()`: **Added**
* `PlexApi.Library.SetStreamOffset()`: **Added**
* `PlexApi.Library.GetItemArtwork()`: **Added**
* `PlexApi.Library.GetMediaPart()`: **Added**
* `PlexApi.Library.GetImageFromBif()`: **Added**
* `PlexApi.Collections.CreateCollection()`: **Added**
* `PlexApi.DvRs.ListDvRs()`: **Added**
* `PlexApi.DvRs.CreateDvr()`: **Added**
* `PlexApi.DvRs.DeleteDvr()`: **Added**
* `PlexApi.DvRs.GetDvr()`: **Added**
* `PlexApi.DvRs.DeleteLineup()`: **Added**
* `PlexApi.DvRs.AddLineup()`: **Added**
* `PlexApi.DvRs.SetDvrPreferences()`: **Added**
* `PlexApi.DvRs.StopDvrReload()`: **Added**
* `PlexApi.DvRs.ReloadGuide()`: **Added**
* `PlexApi.DvRs.TuneChannel()`: **Added**
* `PlexApi.DvRs.RemoveDeviceFromDvr()`: **Added**
* `PlexApi.DvRs.AddDeviceToDvr()`: **Added**
* `PlexApi.Epg.ComputeChannelMap()`: **Added**
* `PlexApi.Epg.GetChannels()`: **Added**
* `PlexApi.Epg.GetCountries()`: **Added**
* `PlexApi.Epg.GetAllLanguages()`: **Added**
* `PlexApi.Epg.GetLineup()`: **Added**
* `PlexApi.Epg.GetLineupChannels()`: **Added**
* `PlexApi.Epg.GetCountriesLineups()`: **Added**
* `PlexApi.Epg.GetCountryRegions()`: **Added**
* `PlexApi.Epg.ListLineups()`: **Added**
* `PlexApi.LiveTv.GetSessions()`: **Added**
* `PlexApi.LiveTv.GetLiveTvSession()`: **Added**
* `PlexApi.LiveTv.GetSessionPlaylistIndex()`: **Added**
* `PlexApi.LiveTv.GetSessionSegment()`: **Added**
* `PlexApi.Log.WriteLog()`: **Added**
* `PlexApi.Log.WriteMessage()`: **Added**
* `PlexApi.Log.EnablePapertrail()`: **Added**
* `PlexApi.Devices.GetAvailableGrabbers()`: **Added**
* `PlexApi.Devices.ListDevices()`: **Added**
* `PlexApi.Devices.AddDevice()`: **Added**
* `PlexApi.Devices.DiscoverDevices()`: **Added**
* `PlexApi.Devices.RemoveDevice()`: **Added**
* `PlexApi.Devices.GetDeviceDetails()`: **Added**
* `PlexApi.Devices.ModifyDevice()`: **Added**
* `PlexApi.Devices.SetChannelmap()`: **Added**
* `PlexApi.Devices.GetDevicesChannels()`: **Added**
* `PlexApi.Devices.SetDevicePreferences()`: **Added**
* `PlexApi.Devices.StopScan()`: **Added**
* `PlexApi.Devices.Scan()`: **Added**
* `PlexApi.Devices.GetThumb()`: **Added**
* `PlexApi.Provider.ListProviders()`: **Added**
* `PlexApi.Provider.AddProvider()`: **Added**
* `PlexApi.Provider.RefreshProviders()`: **Added**
* `PlexApi.Provider.DeleteMediaProvider()`: **Added**
* `PlexApi.Subscriptions.GetAllSubscriptions()`: **Added**
* `PlexApi.Subscriptions.CreateSubscription()`: **Added**
* `PlexApi.Subscriptions.ProcessSubscriptions()`: **Added**
* `PlexApi.Subscriptions.GetScheduledRecordings()`: **Added**
* `PlexApi.Subscriptions.GetTemplate()`: **Added**
* `PlexApi.Subscriptions.CancelGrab()`: **Added**
* `PlexApi.Subscriptions.DeleteSubscription()`: **Added**
* `PlexApi.Subscriptions.GetSubscription()`: **Added**
* `PlexApi.Subscriptions.EditSubscriptionPreferences()`: **Added**
* `PlexApi.Subscriptions.ReorderSubscription()`: **Added**
* `PlexApi.Transcoder.TranscodeImage()`: **Added**
* `PlexApi.Transcoder.MakeDecision()`: **Added**
* `PlexApi.Transcoder.TriggerFallback()`: **Added**
* `PlexApi.Transcoder.TranscodeSubtitles()`: **Added**
* `PlexApi.Transcoder.StartTranscodeSession()`: **Added**
* `PlexApi.Playlist.ListPlaylists()`: **Added**
* `PlexApi.Playlist.GetPlaylist()`: **Added**
* `PlexApi.Playlist.GetPlaylistItems()`: **Added**
* `PlexApi.LibraryPlaylists.CreatePlaylist()`: **Added**
* `PlexApi.LibraryPlaylists.UploadPlaylist()`: **Added**
* `PlexApi.LibraryPlaylists.DeletePlaylist()`: **Added**
* `PlexApi.LibraryPlaylists.UpdatePlaylist()`: **Added**
* `PlexApi.LibraryPlaylists.GetPlaylistGenerators()`: **Added**
* `PlexApi.LibraryPlaylists.ClearPlaylistItems()`: **Added**
* `PlexApi.LibraryPlaylists.AddPlaylistItems()`: **Added**
* `PlexApi.LibraryPlaylists.DeletePlaylistItem()`: **Added**
* `PlexApi.LibraryPlaylists.GetPlaylistGenerator()`: **Added**
* `PlexApi.LibraryPlaylists.GetPlaylistGeneratorItems()`: **Added**
* `PlexApi.LibraryPlaylists.MovePlaylistItem()`: **Added**
* `PlexApi.LibraryPlaylists.RefreshPlaylist()`: **Added**
* `PlexApi.PlayQueue.CreatePlayQueue()`: **Added**
* `PlexApi.PlayQueue.GetPlayQueue()`: **Added**
* `PlexApi.PlayQueue.AddToPlayQueue()`: **Added**
* `PlexApi.PlayQueue.ClearPlayQueue()`: **Added**
* `PlexApi.PlayQueue.ResetPlayQueue()`: **Added**
* `PlexApi.PlayQueue.Shuffle()`: **Added**
* `PlexApi.PlayQueue.Unshuffle()`: **Added**
* `PlexApi.PlayQueue.DeletePlayQueueItem()`: **Added**
* `PlexApi.PlayQueue.MovePlayQueueItem()`: **Added**
* `PlexApi.UltraBlur.GetColors()`: **Added**
* `PlexApi.UltraBlur.GetImage()`: **Added**
* `PlexApi.Status.ListSessions()`: **Added**
* `PlexApi.Status.GetBackgroundTasks()`: **Added**
* `PlexApi.Status.ListPlaybackHistory()`: **Added**
* `PlexApi.Status.TerminateSession()`: **Added**
* `PlexApi.Status.DeleteHistory()`: **Added**
* `PlexApi.Status.GetHistoryItem()`: **Added**
* `PlexApi.Updater.CheckUpdates()`: **Added**
* `PlexApi.Updater.GetUpdatesStatus()`: **Added**
* `PlexApi.Content.GetCollectionItems()`: **Added**
* `PlexApi.Content.GetMetadataItem()`: **Added**
* `PlexApi.Content.GetAlbums()`: **Added**
* `PlexApi.Content.ListContent()`: **Added**
* `PlexApi.Content.GetAllLeaves()`: **Added**
* `PlexApi.Content.GetArts()`: **Added**
* `PlexApi.Content.GetCategories()`: **Added**
* `PlexApi.Content.GetCluster()`: **Added**
* `PlexApi.Content.GetSonicPath()`: **Added**
* `PlexApi.Content.GetFolders()`: **Added**
* `PlexApi.Content.ListMoments()`: **Added**
* `PlexApi.Content.GetSonicallySimilar()`: **Added**
* `PlexApi.Content.GetCollectionImage()`: **Added**
* `PlexApi.LibraryCollections.AddCollectionItems()`: **Added**
* `PlexApi.LibraryCollections.DeleteCollectionItem()`: **Added**
* `PlexApi.LibraryCollections.MoveCollectionItem()`: **Added**
* `PlexApi.Server.GetServerCapabilities()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetServerPreferences()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetAvailableClients()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetDevices()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.Get-Server-Identity()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetMyPlexAccount()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetResizedPhoto()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.Get-Media-Providers()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Server.GetServerList()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Media.MarkPlayed()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Media.MarkUnplayed()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Media.UpdatePlayProgress()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Media.Get-Banner-Image()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Media.Get-Thumb-Image()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Video.GetTimeline()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Video.StartUniversalTranscode()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Activities.GetServerActivities()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Activities.CancelServerActivities()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Butler.GetButlerTasks()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Butler.StartAllTasks()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Butler.StopAllTasks()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetCompanionsData()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetUserFriends()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetGeoData()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetHomeData()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.Get-Server-Resources()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetPin()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Plex.GetTokenByPinId()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Hubs.GetGlobalHubs()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Hubs.Get-Recently-Added()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Hubs.GetLibraryHubs()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Search.PerformSearch()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Search.PerformVoiceSearch()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Search.GetSearchResults()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.GetFileHash()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Recently-Added-Library()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-All-Libraries()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Library-Details()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.DeleteLibrary()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Library-Items()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Library-Sections-All()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Refresh-Library-Metadata()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Search-Library()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Genres-Library()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Countries-Library()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Actors-Library()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Search-All-Libraries()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Media-Meta-Data()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Media-Arts()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Post-Media-Arts()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Get-Media-Posters()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.Post-Media-Poster()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.GetMetadataChildren()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Library.GetTopWatchedContent()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Watchlist.Get-Watch-List()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Log.LogLine()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Log.LogMultiLine()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Log.EnablePaperTrail()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.CreatePlaylist()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.GetPlaylists()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.GetPlaylist()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.DeletePlaylist()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.UpdatePlaylist()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.GetPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.ClearPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.AddPlaylistContents()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Playlists.UploadPlaylist()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Authentication.GetTransientToken()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Authentication.GetSourceConnectionInformation()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Authentication.GetTokenDetails()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Authentication.Post-Users-Sign-In-Data()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Statistics.GetStatistics()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Statistics.GetResourcesStatistics()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Statistics.GetBandwidthStatistics()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Sessions.GetSessions()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Sessions.GetSessionHistory()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Sessions.GetTranscodeSessions()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Sessions.StopTranscodeSession()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Updater.GetUpdateStatus()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Updater.CheckForUpdates()`: **Deleted** **Breaking** ⚠️
* `PlexApi.Users.Get-Users()`: **Deleted** **Breaking** ⚠️
This commit is contained in:
speakeasybot
2025-10-26 10:42:55 +00:00
parent 8c02f6a6ae
commit 835a7430fa
3366 changed files with 111145 additions and 71251 deletions

View File

@@ -3,13 +3,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `Id` | *int* | :heavy_minus_sign: | N/A | 238960586 |
| `Key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `Name` | *string* | :heavy_minus_sign: | N/A | Diane |
| `DefaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | N/A | true |
| `DefaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `SubtitleMode` | *int* | :heavy_minus_sign: | N/A | 1 |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `GlobalViewCount` | *long* | :heavy_minus_sign: | N/A |
| `Id` | *long* | :heavy_minus_sign: | N/A |

View File

@@ -1,9 +1,12 @@
# Action
The action to perform for this item on this optimizer queue
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `Id` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
| `Key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
## Values
| Name | Value |
| ----------- | ----------- |
| `Reprocess` | reprocess |
| `Disable` | disable |
| `Enable` | enable |

View File

@@ -1,12 +0,0 @@
# ActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

View File

@@ -3,13 +3,14 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| `Uuid` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |
| `Cancellable` | *bool* | :heavy_minus_sign: | N/A |
| `UserID` | *double* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Subtitle` | *string* | :heavy_minus_sign: | N/A |
| `Progress` | *double* | :heavy_minus_sign: | N/A |
| `Context` | [Context](../../Models/Requests/Context.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `Cancellable` | *bool* | :heavy_minus_sign: | Indicates whether this activity can be cancelled |
| `Context` | Dictionary<String, *object*> | :heavy_minus_sign: | An object with additional values |
| `Progress` | *double* | :heavy_minus_sign: | A progress percentage. A value of -1 means the progress is indeterminate |
| `Response` | Dictionary<String, *object*> | :heavy_minus_sign: | An object with the response to the async opperation |
| `Subtitle` | *string* | :heavy_minus_sign: | A user-friendly sub-title for this activity |
| `Title` | *string* | :heavy_minus_sign: | A user-friendly title for this activity |
| `Type` | *string* | :heavy_minus_sign: | The type of activity |
| `UserID` | *long* | :heavy_minus_sign: | The user this activity belongs to |
| `Uuid` | *string* | :heavy_minus_sign: | The ID of the activity |

View File

@@ -0,0 +1,20 @@
# AddCollectionItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `CollectionId` | *long* | :heavy_check_mark: | The collection id | |
| `Uri` | *string* | :heavy_check_mark: | The URI describing the items to add to this collection | |

View File

@@ -0,0 +1,11 @@
# AddCollectionItemsResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithMetadata` | [MediaContainerWithMetadata](../../Models/Components/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# AddDeviceRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Uri` | *string* | :heavy_minus_sign: | The URI of the device. | http://10.0.0.5 |

View File

@@ -0,0 +1,11 @@
# AddDeviceResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithDevice` | [MediaContainerWithDevice](../../Models/Components/MediaContainerWithDevice.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,12 @@
# AddDeviceToDVRDVR
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Device` | List<[Models.Components.Device](../../Models/Components/Device.md)> | :heavy_minus_sign: | N/A |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Language` | *string* | :heavy_minus_sign: | N/A |
| `Lineup` | *string* | :heavy_minus_sign: | N/A |
| `Uuid` | *string* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddDeviceToDVRDVRsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `Status` | *long* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |

View File

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

View File

@@ -0,0 +1,20 @@
# AddDeviceToDVRRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `DvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
| `DeviceId` | *long* | :heavy_check_mark: | The ID of the device to add. | |

View File

@@ -0,0 +1,12 @@
# AddDeviceToDVRResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [AddDeviceToDVRResponseBody](../../Models/Requests/AddDeviceToDVRResponseBody.md) | :heavy_minus_sign: | OK |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

View File

@@ -1,10 +1,10 @@
# CreatePlaylistResponseBody
# AddDeviceToDVRResponseBody
returns all playlists
OK
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `MediaContainer` | [CreatePlaylistMediaContainer](../../Models/Requests/CreatePlaylistMediaContainer.md) | :heavy_minus_sign: | N/A |
| `MediaContainer` | [AddDeviceToDVRMediaContainer](../../Models/Requests/AddDeviceToDVRMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddDownloadQueueItemsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `AddedQueueItems` | List<[AddedQueueItems](../../Models/Requests/AddedQueueItems.md)> | :heavy_minus_sign: | N/A |

View File

@@ -1,85 +1,46 @@
# GetRecentlyAddedMetadata
Unknown
# AddDownloadQueueItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AddedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `Art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `AudienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `ChapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `ChildCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `ContentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `CreatedAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `CreatedAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `Duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `GrandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `GrandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `GrandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `GrandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `GrandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `GrandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `GrandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `GrandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `Guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `Index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `Key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `LastRatedAt` | *long* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `LastViewedAt` | *int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `LeafCount` | *int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `LibrarySectionID` | *long* | :heavy_minus_sign: | The identifier for the library section. | 1 |
| `LibrarySectionKey` | *string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | Movies |
| `OriginalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
| `ParentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `ParentIndex` | *int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `ParentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `ParentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `ParentSlug` | *string* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
| `ParentStudio` | *string* | :heavy_check_mark: | The studio of the parent media item. | UCP |
| `ParentTheme` | *string* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
| `ParentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `ParentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `ParentYear` | *int* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
| `PrimaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `RatingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `Rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `SeasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `SkipCount` | *int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `Slug` | *string* | :heavy_check_mark: | A URLfriendly version of the media title. | 4-for-texas |
| `Studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `Subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `Summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `Theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `Thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `TitleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `Type` | [GetRecentlyAddedHubsType](../../Models/Requests/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
| `UpdatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `UserRating` | *float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `ViewCount` | *int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `ViewOffset` | *int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `ViewedLeafCount` | *int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `Year` | *int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `Image` | List<[GetRecentlyAddedImage](../../Models/Requests/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
| `UltraBlurColors` | [UltraBlurColors](../../Models/Requests/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_minus_sign: | N/A | |
| `Media` | List<[Models.Requests.Media](../../Models/Requests/Media.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[Genre](../../Models/Requests/Genre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[Country](../../Models/Requests/Country.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[Director](../../Models/Requests/Director.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[Writer](../../Models/Requests/Writer.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[Role](../../Models/Requests/Role.md)> | :heavy_minus_sign: | N/A | |
| `Producer` | List<[Producer](../../Models/Requests/Producer.md)> | :heavy_minus_sign: | N/A | |
| `Rating1` | List<[Rating](../../Models/Requests/Rating.md)> | :heavy_minus_sign: | N/A | |
| `Similar` | List<[Similar](../../Models/Requests/Similar.md)> | :heavy_minus_sign: | N/A | |
| `Location` | List<[Location](../../Models/Requests/Location.md)> | :heavy_minus_sign: | N/A | |
| `Collection` | List<[Collection](../../Models/Requests/Collection.md)> | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `QueueId` | *long* | :heavy_check_mark: | The queue id | |
| `Keys` | List<*string*> | :heavy_check_mark: | Keys to add | [<br/>"/library/metadata/3",<br/>"/library/metadata/6"<br/>] |
| `AdvancedSubtitles` | [Models.Components.AdvancedSubtitles](../../Models/Components/AdvancedSubtitles.md) | :heavy_minus_sign: | Indicates how incompatible advanced subtitles (such as ass/ssa) should be included: * 'burn' - Burn incompatible advanced text subtitles into the video stream * 'text' - Transcode incompatible advanced text subtitles to a compatible text format, even if some markup is lost<br/> | burn |
| `AudioBoost` | *long* | :heavy_minus_sign: | Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) | 50 |
| `AudioChannelCount` | *long* | :heavy_minus_sign: | Target video number of audio channels. | 5 |
| `AutoAdjustQuality` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports ABR. | 1 |
| `AutoAdjustSubtitle` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates if the server should adjust subtitles based on Voice Activity Data. | 1 |
| `DirectPlay` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct playing the indicated content. | 1 |
| `DirectStream` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the video of the indicated content. | 1 |
| `DirectStreamAudio` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates the client supports direct streaming the audio of the indicated content. | 1 |
| `DisableResolutionRotation` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicates if resolution should be adjusted for orientation. | 1 |
| `HasMDE` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 | 1 |
| `Location` | [Models.Components.Location](../../Models/Components/Location.md) | :heavy_minus_sign: | Network type of the client, can be used to help determine target bitrate. | wan |
| `MediaBufferSize` | *long* | :heavy_minus_sign: | Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. | 102400 |
| `MediaIndex` | *long* | :heavy_minus_sign: | Index of the media to transcode. -1 or not specified indicates let the server choose. | 0 |
| `MusicBitrate` | *long* | :heavy_minus_sign: | Target bitrate for audio only files (in kbps, used to transcode). | 5000 |
| `Offset` | *double* | :heavy_minus_sign: | Offset from the start of the media (in seconds). | 90.5 |
| `PartIndex` | *long* | :heavy_minus_sign: | Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode | 0 |
| `Path` | *string* | :heavy_minus_sign: | Internal PMS path of the media to transcode. | /library/metadata/151671 |
| `PeakBitrate` | *long* | :heavy_minus_sign: | Maximum bitrate (in kbps) to use in ABR. | 12000 |
| `PhotoResolution` | *string* | :heavy_minus_sign: | Target photo resolution. | 1080x1080 |
| `Protocol` | [Models.Components.Protocol](../../Models/Components/Protocol.md) | :heavy_minus_sign: | Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022)<br/> | dash |
| `SecondsPerSegment` | *long* | :heavy_minus_sign: | Number of seconds to include in each transcoded segment | 5 |
| `SubtitleSize` | *long* | :heavy_minus_sign: | Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) | 50 |
| `Subtitles` | [Models.Components.Subtitles](../../Models/Components/Subtitles.md) | :heavy_minus_sign: | Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream<br/> | Burn |
| `VideoBitrate` | *long* | :heavy_minus_sign: | Target video bitrate (in kbps). | 12000 |
| `VideoQuality` | *long* | :heavy_minus_sign: | Target photo quality. | 50 |
| `VideoResolution` | *string* | :heavy_minus_sign: | Target maximum video resolution. | 1080x1080 |

View File

@@ -1,4 +1,4 @@
# GetAvailableClientsResponse
# AddDownloadQueueItemsResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetAvailableClientsResponseBody](../../Models/Requests/GetAvailableClientsResponseBody.md) | :heavy_minus_sign: | Available Clients |
| `Object` | [AddDownloadQueueItemsResponseBody](../../Models/Requests/AddDownloadQueueItemsResponseBody.md) | :heavy_minus_sign: | OK |

View File

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

View File

@@ -0,0 +1,22 @@
# AddExtrasRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Ids` | *string* | :heavy_check_mark: | N/A | |
| `ExtraType` | *long* | :heavy_minus_sign: | The metadata type of the extra | |
| `Url` | *string* | :heavy_check_mark: | The URL of the extra | |
| `Title` | *string* | :heavy_minus_sign: | The title to filter by or assign | |

View File

@@ -1,4 +1,4 @@
# GetFileHashResponse
# AddExtrasResponse
## Fields

View File

@@ -0,0 +1,12 @@
# AddLineupDVR
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Device` | List<[Models.Components.Device](../../Models/Components/Device.md)> | :heavy_minus_sign: | N/A |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Language` | *string* | :heavy_minus_sign: | N/A |
| `Lineup` | *string* | :heavy_minus_sign: | N/A |
| `Uuid` | *string* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,17 @@
# AddLineupDVRsMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `Status` | *long* | :heavy_minus_sign: | A status indicator. If present and non-zero, indicates an error |

View File

@@ -1,10 +1,9 @@
# GetGlobalHubsResponseBody
returns global hubs
# AddLineupMediaContainer
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `MediaContainer` | [GetGlobalHubsMediaContainer](../../Models/Requests/GetGlobalHubsMediaContainer.md) | :heavy_minus_sign: | N/A |
| `MediaContainer` | [AddLineupDVRsMediaContainer](../../Models/Requests/AddLineupDVRsMediaContainer.md) | :heavy_minus_sign: | N/A |
| `Dvr` | List<[AddLineupDVR](../../Models/Requests/AddLineupDVR.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,20 @@
# AddLineupRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `DvrId` | *long* | :heavy_check_mark: | The ID of the DVR. | |
| `Lineup` | *string* | :heavy_check_mark: | The lineup to delete | |

View File

@@ -1,4 +1,4 @@
# GetThumbImageResponse
# AddLineupResponse
## Fields
@@ -8,5 +8,5 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Bytes` | *byte[]* | :heavy_minus_sign: | Successful response returning an image |
| `Object` | [AddLineupResponseBody](../../Models/Requests/AddLineupResponseBody.md) | :heavy_minus_sign: | OK |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# AddLineupResponseBody
OK
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `MediaContainer` | [AddLineupMediaContainer](../../Models/Requests/AddLineupMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -1,11 +0,0 @@
# AddPlaylistContentsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 1 |
| `LeafCountAdded` | *int* | :heavy_minus_sign: | N/A | 1 |
| `LeafCountRequested` | *int* | :heavy_minus_sign: | N/A | 1 |
| `Metadata` | List<[AddPlaylistContentsMetadata](../../Models/Requests/AddPlaylistContentsMetadata.md)> | :heavy_minus_sign: | N/A | |

View File

@@ -1,20 +0,0 @@
# AddPlaylistContentsMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
| `Key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `Guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `Type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `Title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
| `Summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
| `Smart` | *bool* | :heavy_minus_sign: | N/A | false |
| `PlaylistType` | *string* | :heavy_minus_sign: | N/A | video |
| `Composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `Duration` | *int* | :heavy_minus_sign: | N/A | 423000 |
| `LeafCount` | *int* | :heavy_minus_sign: | N/A | 3 |
| `AddedAt` | *int* | :heavy_minus_sign: | N/A | 1705716458 |
| `UpdatedAt` | *int* | :heavy_minus_sign: | N/A | 1705800070 |

View File

@@ -1,10 +0,0 @@
# AddPlaylistContentsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `PlaylistID` | *double* | :heavy_check_mark: | the ID of the playlist | |
| `Uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `PlayQueueID` | *double* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |

View File

@@ -0,0 +1,21 @@
# AddPlaylistItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `PlaylistId` | *long* | :heavy_check_mark: | The ID of the playlist | |
| `Uri` | *string* | :heavy_minus_sign: | The content URI for the playlist. | |
| `PlayQueueID` | *long* | :heavy_minus_sign: | The play queue to add to a playlist. | |

View File

@@ -0,0 +1,11 @@
# AddPlaylistItemsResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithPlaylistMetadata` | [MediaContainerWithPlaylistMetadata](../../Models/Components/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# AddProviderRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Url` | *string* | :heavy_check_mark: | The URL of the media provider to add. | |

View File

@@ -1,4 +1,4 @@
# GetTimelineResponse
# AddProviderResponse
## Fields

View File

@@ -0,0 +1,28 @@
# AddSectionRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Name` | *string* | :heavy_check_mark: | The name of the new section | |
| `Type` | *long* | :heavy_check_mark: | The type of library section | |
| `Scanner` | *string* | :heavy_minus_sign: | The scanner this section should use | |
| `Agent` | *string* | :heavy_check_mark: | The agent this section should use for metadata | |
| `MetadataAgentProviderGroupId` | *string* | :heavy_minus_sign: | The agent group id for this section | |
| `Language` | *string* | :heavy_check_mark: | The language of this section | |
| `Locations` | List<*string*> | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
| `Prefs` | [QueryParamPrefs](../../Models/Requests/QueryParamPrefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
| `Relative` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
| `ImportFromiTunes` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 |

View File

@@ -1,4 +1,4 @@
# GetUserFriendsResponse
# AddSectionResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Friends` | List<[Friend](../../Models/Requests/Friend.md)> | :heavy_minus_sign: | Friends Data |
| `SlashGetResponses200` | [SlashGetResponses200](../../Models/Components/SlashGetResponses200.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,26 @@
# AddSubtitlesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Ids` | *string* | :heavy_check_mark: | N/A | |
| `Title` | *string* | :heavy_minus_sign: | N/A | |
| `Language` | *string* | :heavy_minus_sign: | N/A | |
| `MediaItemID` | *long* | :heavy_minus_sign: | N/A | |
| `Url` | *string* | :heavy_minus_sign: | The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body | |
| `Format` | *string* | :heavy_minus_sign: | N/A | |
| `Forced` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |
| `HearingImpaired` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | N/A | 1 |

View File

@@ -1,4 +1,4 @@
# LogMultiLineResponse
# AddSubtitlesResponse
## Fields

View File

@@ -0,0 +1,22 @@
# AddToPlayQueueRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `PlayQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |
| `Uri` | *string* | :heavy_minus_sign: | The content URI for what we're adding to the queue. | |
| `PlaylistID` | *string* | :heavy_minus_sign: | The ID of the playlist to add to the playQueue. | |
| `Next` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Play this item next (defaults to 0 - queueing at the end of manually queued items). | 1 |

View File

@@ -0,0 +1,11 @@
# AddToPlayQueueResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithPlaylistMetadata` | [MediaContainerWithPlaylistMetadata](../../Models/Components/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,9 @@
# AddedQueueItems
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_minus_sign: | The queue item id that was added or the existing one if an item already exists in this queue with the same parameters |
| `Key` | *string* | :heavy_minus_sign: | The key added to the queue |

View File

@@ -0,0 +1,13 @@
# AdvancedSubtitles
## Values
| Name | Value |
| ----------- | ----------- |
| `Auto` | auto |
| `Burn` | burn |
| `None` | none |
| `Sidecar` | sidecar |
| `Embedded` | embedded |
| `Segmented` | segmented |

View File

@@ -1,11 +0,0 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,11 +0,0 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,11 +0,0 @@
# AllowChannels
Indicates if the user has access to channels.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,11 +0,0 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,11 +0,0 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -1,11 +0,0 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,21 @@
# AnalyzeMetadataRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Ids` | *string* | :heavy_check_mark: | N/A | |
| `ThumbOffset` | *double* | :heavy_minus_sign: | Set the offset to be used for thumbnails | |
| `ArtOffset` | *double* | :heavy_minus_sign: | Set the offset to be used for artwork | |

View File

@@ -1,4 +1,4 @@
# CheckForUpdatesResponse
# AnalyzeMetadataResponse
## Fields

View File

@@ -3,7 +3,18 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Tonight` | [Tonight](../../Models/Requests/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` | [Skip](../../Models/Requests/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 |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Tonight` | [BoolInt](../../Models/Components/BoolInt.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 immediately. | 1 |
| `Skip` | [BoolInt](../../Models/Components/BoolInt.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 |

View File

@@ -1,4 +1,6 @@
# SharedServers
# Args
The new values for the metadata item
## Fields

View File

@@ -1,11 +1,9 @@
# Attributes
Attributes associated with the marker.
The attributes to assign to this marker
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
| `Version` | *long* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

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

View File

@@ -0,0 +1,22 @@
# AutocompleteRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `SectionId` | *long* | :heavy_check_mark: | Section identifier | |
| `Type` | *long* | :heavy_minus_sign: | Item type | |
| `FieldQuery` | *string* | :heavy_minus_sign: | The "field" stands in for any field, the value is a partial string for matching | |
| `MediaQuery` | [MediaQuery](../../Models/Components/MediaQuery.md) | :heavy_minus_sign: | This is a complex query built of several parameters. See [API Info section](#section/API-Info/Media-Queries) for information on building media queries | |

View File

@@ -0,0 +1,12 @@
# AutocompleteResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithMetadata` | [MediaContainerWithMetadata](../../Models/Components/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,10 @@
# Bandwidth
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `BandwidthValue` | *long* | :heavy_minus_sign: | The bandwidth at this time in kbps |
| `Resolution` | *string* | :heavy_minus_sign: | The user-friendly resolution at this time |
| `Time` | *long* | :heavy_minus_sign: | Media playback time where this bandwidth started |

View File

@@ -0,0 +1,10 @@
# Bandwidths
A list of media times and bandwidths when trascoding is using with auto adjustment of bandwidth
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `Bandwidth` | List<[Bandwidth](../../Models/Requests/Bandwidth.md)> | :heavy_minus_sign: | N/A |

View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `Name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
| `Interval` | *double* | :heavy_minus_sign: | N/A | 3 |
| `ScheduleRandomized` | *bool* | :heavy_minus_sign: | N/A | |
| `Enabled` | *bool* | :heavy_minus_sign: | N/A | |
| `Title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
| `Description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `Description` | *string* | :heavy_minus_sign: | A user-friendly description of the task |
| `Enabled` | *bool* | :heavy_minus_sign: | Whether this task is enabled or not |
| `Interval` | *long* | :heavy_minus_sign: | The interval (in days) of when this task is run. A value of 1 is run every day, 7 is every week, etc. |
| `Name` | *string* | :heavy_minus_sign: | The name of the task |
| `ScheduleRandomized` | *bool* | :heavy_minus_sign: | Indicates whether the timing of the task is randomized within the butler interval |
| `Title` | *string* | :heavy_minus_sign: | A user-friendly title of the task |

View File

@@ -0,0 +1,19 @@
# CancelActivityRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `ActivityId` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | d6199ba1-fb5e-4cae-bf17-1a5369c1cf1e |

View File

@@ -0,0 +1,10 @@
# CancelActivityResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# CancelGrabRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `OperationId` | *string* | :heavy_check_mark: | The ID of the operation. | |

View File

@@ -0,0 +1,10 @@
# CancelGrabResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# CancelRefreshRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `SectionId` | *long* | :heavy_check_mark: | Section identifier | |

View File

@@ -1,4 +1,4 @@
# DeleteLibraryResponse
# CancelRefreshResponse
## Fields

View File

@@ -1,8 +0,0 @@
# CancelServerActivitiesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `ActivityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |

View File

@@ -0,0 +1,9 @@
# ChannelMapping
The mapping of changes, passed as a map of device channel to lineup VCN.
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -0,0 +1,9 @@
# ChannelMappingByKey
The mapping of changes, passed as a map of device channel to lineup key.
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

View File

@@ -1,15 +0,0 @@
# Chapter
The thumbnail for the chapter
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `Id` | *long* | :heavy_check_mark: | N/A | 4 |
| `Filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
| `Index` | *long* | :heavy_check_mark: | N/A | 1 |
| `StartTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
| `EndTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
| `Thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |

View File

@@ -1,8 +0,0 @@
# CheckForUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `Download` | [Download](../../Models/Requests/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -0,0 +1,19 @@
# CheckUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Download` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -0,0 +1,10 @@
# CheckUpdatesResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# ChromaSubsampling
Use the specified chroma subsambling.
- 0: 411
- 1: 420
- 2: 422
- 3: 444
Defaults to 3 (444)
## Values
| Name | Value |
| ------- | ------- |
| `Zero` | 0 |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |

View File

@@ -0,0 +1,10 @@
# CleanBundlesResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,19 @@
# ClearPlayQueueRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `PlayQueueId` | *long* | :heavy_check_mark: | The ID of the play queue. | |

View File

@@ -0,0 +1,11 @@
# ClearPlayQueueResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithPlaylistMetadata` | [MediaContainerWithPlaylistMetadata](../../Models/Components/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,19 @@
# ClearPlaylistItemsRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `PlaylistId` | *long* | :heavy_check_mark: | The ID of the playlist | |

View File

@@ -0,0 +1,11 @@
# ClearPlaylistItemsResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithPlaylistMetadata` | [MediaContainerWithPlaylistMetadata](../../Models/Components/MediaContainerWithPlaylistMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -1,8 +0,0 @@
# Collection
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `Tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

View File

@@ -0,0 +1,11 @@
# ComputeChannelMapChannelMapping
## Fields
| Field | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `ChannelKey` | *string* | :heavy_minus_sign: | N/A |
| `DeviceIdentifier` | *string* | :heavy_minus_sign: | The channel description on the device |
| `Favorite` | *bool* | :heavy_minus_sign: | N/A |
| `LineupIdentifier` | *string* | :heavy_minus_sign: | The channel identifier in the lineup |

View File

@@ -0,0 +1,17 @@
# ComputeChannelMapMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `ChannelMapping` | List<[ComputeChannelMapChannelMapping](../../Models/Requests/ComputeChannelMapChannelMapping.md)> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,20 @@
# ComputeChannelMapRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `DeviceQueryParameter` | *string* | :heavy_check_mark: | The URI describing the device | |
| `Lineup` | *string* | :heavy_check_mark: | The URI describing the lineup | |

View File

@@ -0,0 +1,12 @@
# ComputeChannelMapResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [ComputeChannelMapResponseBody](../../Models/Requests/ComputeChannelMapResponseBody.md) | :heavy_minus_sign: | OK |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

View File

@@ -1,10 +1,10 @@
# GetSessionHistoryResponseBody
# ComputeChannelMapResponseBody
List of Plex Sessions
OK
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetSessionHistoryMediaContainer](../../Models/Requests/GetSessionHistoryMediaContainer.md) | :heavy_minus_sign: | N/A |
| `MediaContainer` | [ComputeChannelMapMediaContainer](../../Models/Requests/ComputeChannelMapMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -1,21 +1,19 @@
# GetPinAuthPinContainer
Requests a new pin id used in the authentication flow
# ConnectWebSocketRequest
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | N/A | 308667304 |
| `Code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
| `Product` | *string* | :heavy_check_mark: | N/A | Tautulli |
| `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 | Tautulli |
| `Location` | [GeoData](../../Models/Requests/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` | *long* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `CreatedAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `ExpiresAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `AuthToken` | *string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `NewRegistration` | *object* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Filter` | List<*string*> | :heavy_minus_sign: | By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:<br/><br/>- `filters=-log`: All event types except logs (the default).<br/>- `filters=foo,bar`: Only the foo and bar event types.<br/>- `filters=`: All events types.<br/>- `filters=-foo,bar`: All event types except foo and bar.<br/> | |

View File

@@ -1,4 +1,4 @@
# GetCompanionsDataResponse
# ConnectWebSocketResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `ResponseBodies` | List<[ResponseBody](../../Models/Requests/ResponseBody.md)> | :heavy_minus_sign: | Companions Data |
| `Bytes` | *byte[]* | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,13 @@
# Connection
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `Address` | *string* | :heavy_minus_sign: | N/A |
| `Local` | *bool* | :heavy_minus_sign: | Indicates if the connection is the server's LAN address |
| `Port` | *long* | :heavy_minus_sign: | N/A |
| `Protocol` | *string* | :heavy_minus_sign: | N/A |
| `Relay` | *bool* | :heavy_minus_sign: | Indicates the connection is over a relayed connection |
| `Uri` | *string* | :heavy_minus_sign: | N/A |

View File

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

View File

@@ -1,12 +1,15 @@
# Country
The filter query string for country media items.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `Id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `Filter` | *string* | :heavy_check_mark: | N/A | country=19 |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Code` | *string* | :heavy_minus_sign: | Three letter code |
| `Example` | *string* | :heavy_minus_sign: | N/A |
| `Flavor` | [Flavor](../../Models/Requests/Flavor.md) | :heavy_minus_sign: | - `0`: The country is divided into regions, and following the key will lead to a list of regions.<br/>- `1`: The county is divided by postal codes, and an example code is returned in `example`.<br/>- `2`: The country has a single postal code, returned in `example`.<br/> |
| `Key` | *string* | :heavy_minus_sign: | N/A |
| `Language` | *string* | :heavy_minus_sign: | Three letter language code |
| `LanguageTitle` | *string* | :heavy_minus_sign: | The title of the language |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Type` | *string* | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,23 @@
# CreateCollectionRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `SectionId` | *string* | :heavy_check_mark: | The section where this collection will be created | |
| `Title` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
| `Smart` | *bool* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
| `Uri` | *string* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
| `Type` | *long* | :heavy_minus_sign: | The metadata type to filter by | |

View File

@@ -0,0 +1,11 @@
# CreateCollectionResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `MediaContainerWithMetadata` | [MediaContainerWithMetadata](../../Models/Components/MediaContainerWithMetadata.md) | :heavy_minus_sign: | OK |

View File

@@ -0,0 +1,23 @@
# CreateCustomHubRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `SectionId` | *long* | :heavy_check_mark: | The section ID for the hubs to reorder | |
| `MetadataItemId` | *long* | :heavy_check_mark: | The metadata item on which to base this hub. This must currently be a collection | |
| `PromotedToRecommended` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in recommended | 1 |
| `PromotedToOwnHome` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in admin's home | 1 |
| `PromotedToSharedHome` | [BoolInt](../../Models/Components/BoolInt.md) | :heavy_minus_sign: | Whether this hub should be displayed in shared user's home | 1 |

View File

@@ -1,4 +1,4 @@
# GetResizedPhotoResponse
# CreateCustomHubResponse
## Fields

View File

@@ -0,0 +1,21 @@
# CreateDVRRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Lineup` | *string* | :heavy_minus_sign: | The EPG lineup. | lineup://tv.plex.providers.epg.onconnect/USA-HI51418-DEFAULT |
| `DeviceQueryParameter` | List<*string*> | :heavy_minus_sign: | The device. | device[]=device://tv.plex.grabbers.hdhomerun/1053C0CA |
| `Language` | *string* | :heavy_minus_sign: | The language. | eng |

View File

@@ -0,0 +1,12 @@
# CreateDVRResponse
## 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` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `DvrRequestHandlerSlashGetResponses200` | [DvrRequestHandlerSlashGetResponses200](../../Models/Components/DvrRequestHandlerSlashGetResponses200.md) | :heavy_minus_sign: | OK |
| `Headers` | Dictionary<String, List<*string*>> | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,17 @@
# CreateDownloadQueueMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `DownloadQueue` | List<[Models.Requests.DownloadQueue](../../Models/Requests/DownloadQueue.md)> | :heavy_minus_sign: | N/A |

View File

@@ -1,4 +1,4 @@
# AddPlaylistContentsResponse
# CreateDownloadQueueResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [AddPlaylistContentsResponseBody](../../Models/Requests/AddPlaylistContentsResponseBody.md) | :heavy_minus_sign: | Playlist Updated |
| `Object` | [CreateDownloadQueueResponseBody](../../Models/Requests/CreateDownloadQueueResponseBody.md) | :heavy_minus_sign: | OK |

View File

@@ -1,10 +1,10 @@
# AddPlaylistContentsResponseBody
# CreateDownloadQueueResponseBody
Playlist Updated
OK
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `MediaContainer` | [AddPlaylistContentsMediaContainer](../../Models/Requests/AddPlaylistContentsMediaContainer.md) | :heavy_minus_sign: | N/A |
| `MediaContainer` | [CreateDownloadQueueMediaContainer](../../Models/Requests/CreateDownloadQueueMediaContainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,23 @@
# CreateMarkerMediaContainer
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_minus_sign: | N/A |
| `Offset` | *long* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
| `Size` | *long* | :heavy_minus_sign: | N/A |
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
| `Color` | *string* | :heavy_minus_sign: | N/A |
| `EndTimeOffset` | *long* | :heavy_minus_sign: | N/A |
| `Id` | *long* | :heavy_minus_sign: | N/A |
| `StartTimeOffset` | *long* | :heavy_minus_sign: | N/A |
| `Title` | *string* | :heavy_minus_sign: | N/A |
| `Type` | [CreateMarkerType](../../Models/Requests/CreateMarkerType.md) | :heavy_minus_sign: | N/A |
| `AdditionalProperties` | Dictionary<String, *object*> | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,23 @@
# CreateMarkerRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `Accepts` | [Accepts](../../Models/Components/Accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
| `ClientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
| `Product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
| `Version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
| `Platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
| `PlatformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `Device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `Model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `DeviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
| `DeviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
| `Marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
| `Ids` | *string* | :heavy_check_mark: | N/A | |
| `Type` | *long* | :heavy_check_mark: | The type of marker to edit/create | |
| `StartTimeOffset` | *long* | :heavy_check_mark: | The start time of the marker | |
| `EndTimeOffset` | *long* | :heavy_minus_sign: | The end time of the marker | |
| `Attributes` | [Attributes](../../Models/Requests/Attributes.md) | :heavy_minus_sign: | The attributes to assign to this marker | {<br/>"title": "My favorite spot"<br/>} |

View File

@@ -1,4 +1,4 @@
# GetPlaylistsResponse
# CreateMarkerResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetPlaylistsResponseBody](../../Models/Requests/GetPlaylistsResponseBody.md) | :heavy_minus_sign: | returns all playlists |
| `Object` | [CreateMarkerResponseBody](../../Models/Requests/CreateMarkerResponseBody.md) | :heavy_minus_sign: | OK |

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