mirror of
https://github.com/LukeHagar/plexswift.git
synced 2025-12-07 04:20:54 +00:00
814 lines
31 KiB
Markdown
814 lines
31 KiB
Markdown
# ``plexswift``
|
|
|
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
|
|
|
`plexswift` is a Swift library which provides functionality for making requests to the API using a modern, easy-to-use Swift API:
|
|
|
|
### SDK Example Usage
|
|
|
|
```swift
|
|
import Foundation
|
|
import Plexswift
|
|
|
|
let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))
|
|
|
|
let response = try await client.server.getServerCapabilities()
|
|
|
|
switch response.data {
|
|
case .object(let object):
|
|
// Handle response
|
|
break
|
|
case .badRequest(let badRequest):
|
|
// Handle response
|
|
break
|
|
case .unauthorized(let unauthorized):
|
|
// Handle response
|
|
break
|
|
case .empty:
|
|
// Handle empty response
|
|
break
|
|
}
|
|
|
|
```
|
|
|
|
### Getting started
|
|
- ``PlexswiftAPI`` defines the available API operations, including operations which are logically grouped by name (for example under ``PlexswiftAPI/server``).
|
|
- ``Client`` is the main object used when making requests to the API, and implements ``PlexswiftAPI`` to provide this functionality. Each available API method is exposed as an `async` function, which you can call and `await` its response and handle any errors that are thrown.
|
|
- API methods that require input data take a *request object* describing these parameters, and each method returns a *response object* containing information about the response. You can read more about these in <doc:Client#Request-and-response-objects>.
|
|
- Requests to the API must be authenticated. You can provide authentication credentials by initializing ``Client`` with a ``Shared/Security`` value.
|
|
- If an error occurs when making a request to the API, a ``PlexswiftError`` error is thrown with more information about what went wrong.
|
|
|
|
## Topics
|
|
|
|
### Connecting to the API
|
|
|
|
- ``Client``
|
|
- ``GlobalParameters``
|
|
- ``Shared/Security``
|
|
- ``Response``
|
|
- ``ResponseWithHeaders``
|
|
- ``ResponseFields``
|
|
- ``ResponseHeaders``
|
|
- ``PlexswiftError``
|
|
|
|
### API operations
|
|
|
|
- ``plexswift/PlexswiftAPI``
|
|
- ``ServerAPI``
|
|
- ``MediaAPI``
|
|
- ``VideoAPI``
|
|
- ``ActivitiesAPI``
|
|
- ``ButlerAPI``
|
|
- ``PlexAPI``
|
|
- ``HubsAPI``
|
|
- ``SearchAPI``
|
|
- ``LibraryAPI``
|
|
- ``WatchlistAPI``
|
|
- ``LogAPI``
|
|
- ``PlaylistsAPI``
|
|
- ``AuthenticationAPI``
|
|
- ``StatisticsAPI``
|
|
- ``SessionsAPI``
|
|
- ``UpdaterAPI``
|
|
|
|
### Server configuration
|
|
- ``PlexServers/GetCompanionsData``
|
|
- ``PlexServers/GetUserFriends``
|
|
- ``PlexServers/GetGeoData``
|
|
- ``PlexServers/GetServerResources``
|
|
- ``PlexServers/GetPin``
|
|
- ``PlexServers/GetTokenByPinId``
|
|
- ``WatchlistServers/GetWatchList``
|
|
- ``AuthenticationServers/GetTokenDetails``
|
|
- ``AuthenticationServers/PostUsersSignInData``
|
|
|
|
### Shared models
|
|
|
|
### Request objects
|
|
- ``Operations/AddPlaylistContentsBadRequest``
|
|
- ``Operations/ApplyUpdatesBadRequest``
|
|
- ``Operations/CancelServerActivitiesBadRequest``
|
|
- ``Operations/CheckForUpdatesBadRequest``
|
|
- ``Operations/ClearPlaylistContentsBadRequest``
|
|
- ``Operations/CreatePlaylistBadRequest``
|
|
- ``Operations/DeleteLibraryBadRequest``
|
|
- ``Operations/DeletePlaylistBadRequest``
|
|
- ``Operations/EnablePaperTrailBadRequest``
|
|
- ``Operations/GetAllLibrariesBadRequest``
|
|
- ``Operations/GetBannerImageBadRequest``
|
|
- ``Operations/GetLibraryDetailsBadRequest``
|
|
- ``Operations/GetLibraryItemsBadRequest``
|
|
- ``Operations/GetMediaProvidersBadRequest``
|
|
- ``Operations/GetMetaDataByRatingKeyBadRequest``
|
|
- ``Operations/GetRefreshLibraryMetadataBadRequest``
|
|
- ``Operations/GetSearchLibraryBadRequest``
|
|
- ``Operations/GetServerResourcesBadRequest``
|
|
- ``Operations/GetThumbImageBadRequest``
|
|
- ``Operations/GetWatchListBadRequest``
|
|
- ``Operations/GetAvailableClientsBadRequest``
|
|
- ``Operations/GetBandwidthStatisticsBadRequest``
|
|
- ``Operations/GetButlerTasksBadRequest``
|
|
- ``Operations/GetCompanionsDataBadRequest``
|
|
- ``Operations/GetDevicesBadRequest``
|
|
- ``Operations/GetFileHashBadRequest``
|
|
- ``Operations/GetGeoDataBadRequest``
|
|
- ``Operations/GetGlobalHubsBadRequest``
|
|
- ``Operations/GetHomeDataBadRequest``
|
|
- ``Operations/GetLibraryHubsBadRequest``
|
|
- ``Operations/GetMetadataChildrenBadRequest``
|
|
- ``Operations/GetMyPlexAccountBadRequest``
|
|
- ``Operations/GetOnDeckBadRequest``
|
|
- ``Operations/GetPinBadRequest``
|
|
- ``Operations/GetPlaylistBadRequest``
|
|
- ``Operations/GetPlaylistContentsBadRequest``
|
|
- ``Operations/GetPlaylistsBadRequest``
|
|
- ``Operations/GetRecentlyAddedBadRequest``
|
|
- ``Operations/GetResizedPhotoBadRequest``
|
|
- ``Operations/GetResourcesStatisticsBadRequest``
|
|
- ``Operations/GetSearchResultsBadRequest``
|
|
- ``Operations/GetServerActivitiesBadRequest``
|
|
- ``Operations/GetServerCapabilitiesBadRequest``
|
|
- ``Operations/GetServerListBadRequest``
|
|
- ``Operations/GetServerPreferencesBadRequest``
|
|
- ``Operations/GetSessionHistoryBadRequest``
|
|
- ``Operations/GetSessionsBadRequest``
|
|
- ``Operations/GetSourceConnectionInformationBadRequest``
|
|
- ``Operations/GetStatisticsBadRequest``
|
|
- ``Operations/GetTimelineBadRequest``
|
|
- ``Operations/GetTokenByPinIdBadRequest``
|
|
- ``Operations/GetTokenDetailsBadRequest``
|
|
- ``Operations/GetTopWatchedContentBadRequest``
|
|
- ``Operations/GetTranscodeSessionsBadRequest``
|
|
- ``Operations/GetTransientTokenBadRequest``
|
|
- ``Operations/GetUpdateStatusBadRequest``
|
|
- ``Operations/GetUserFriendsBadRequest``
|
|
- ``Operations/LogLineBadRequest``
|
|
- ``Operations/LogMultiLineBadRequest``
|
|
- ``Operations/MarkPlayedBadRequest``
|
|
- ``Operations/MarkUnplayedBadRequest``
|
|
- ``Operations/PerformSearchBadRequest``
|
|
- ``Operations/PerformVoiceSearchBadRequest``
|
|
- ``Operations/PostUsersSignInDataBadRequest``
|
|
- ``Operations/StartAllTasksBadRequest``
|
|
- ``Operations/StartTaskBadRequest``
|
|
- ``Operations/StartUniversalTranscodeBadRequest``
|
|
- ``Operations/StopAllTasksBadRequest``
|
|
- ``Operations/StopTaskBadRequest``
|
|
- ``Operations/StopTranscodeSessionBadRequest``
|
|
- ``Operations/UpdatePlaylistBadRequest``
|
|
- ``Operations/UpdatePlayProgressBadRequest``
|
|
- ``Operations/UploadPlaylistBadRequest``
|
|
|
|
### Response objects
|
|
- ``Operations/AddPlaylistContentsResponse``
|
|
- ``Operations/ApplyUpdatesResponse``
|
|
- ``Operations/CancelServerActivitiesResponse``
|
|
- ``Operations/CheckForUpdatesResponse``
|
|
- ``Operations/ClearPlaylistContentsResponse``
|
|
- ``Operations/CreatePlaylistResponse``
|
|
- ``Operations/DeleteLibraryResponse``
|
|
- ``Operations/DeletePlaylistResponse``
|
|
- ``Operations/EnablePaperTrailResponse``
|
|
- ``Operations/GetAllLibrariesResponse``
|
|
- ``Operations/GetBannerImageResponse``
|
|
- ``Operations/GetLibraryDetailsResponse``
|
|
- ``Operations/GetLibraryItemsResponse``
|
|
- ``Operations/GetMediaProvidersResponse``
|
|
- ``Operations/GetMetaDataByRatingKeyResponse``
|
|
- ``Operations/GetRefreshLibraryMetadataResponse``
|
|
- ``Operations/GetSearchLibraryResponse``
|
|
- ``Operations/GetServerIdentityResponse``
|
|
- ``Operations/GetServerResourcesResponse``
|
|
- ``Operations/GetThumbImageResponse``
|
|
- ``Operations/GetWatchListResponse``
|
|
- ``Operations/GetAvailableClientsResponse``
|
|
- ``Operations/GetBandwidthStatisticsResponse``
|
|
- ``Operations/GetButlerTasksResponse``
|
|
- ``Operations/GetCompanionsDataResponse``
|
|
- ``Operations/GetDevicesResponse``
|
|
- ``Operations/GetFileHashResponse``
|
|
- ``Operations/GetGeoDataResponse``
|
|
- ``Operations/GetGlobalHubsResponse``
|
|
- ``Operations/GetHomeDataResponse``
|
|
- ``Operations/GetLibraryHubsResponse``
|
|
- ``Operations/GetMetadataChildrenResponse``
|
|
- ``Operations/GetMyPlexAccountResponse``
|
|
- ``Operations/GetOnDeckResponse``
|
|
- ``Operations/GetPinResponse``
|
|
- ``Operations/GetPlaylistResponse``
|
|
- ``Operations/GetPlaylistContentsResponse``
|
|
- ``Operations/GetPlaylistsResponse``
|
|
- ``Operations/GetRecentlyAddedResponse``
|
|
- ``Operations/GetResizedPhotoResponse``
|
|
- ``Operations/GetResourcesStatisticsResponse``
|
|
- ``Operations/GetSearchResultsResponse``
|
|
- ``Operations/GetServerActivitiesResponse``
|
|
- ``Operations/GetServerCapabilitiesResponse``
|
|
- ``Operations/GetServerListResponse``
|
|
- ``Operations/GetServerPreferencesResponse``
|
|
- ``Operations/GetSessionHistoryResponse``
|
|
- ``Operations/GetSessionsResponse``
|
|
- ``Operations/GetSourceConnectionInformationResponse``
|
|
- ``Operations/GetStatisticsResponse``
|
|
- ``Operations/GetTimelineResponse``
|
|
- ``Operations/GetTokenByPinIdResponse``
|
|
- ``Operations/GetTokenDetailsResponse``
|
|
- ``Operations/GetTopWatchedContentResponse``
|
|
- ``Operations/GetTranscodeSessionsResponse``
|
|
- ``Operations/GetTransientTokenResponse``
|
|
- ``Operations/GetUpdateStatusResponse``
|
|
- ``Operations/GetUserFriendsResponse``
|
|
- ``Operations/LogLineResponse``
|
|
- ``Operations/LogMultiLineResponse``
|
|
- ``Operations/MarkPlayedResponse``
|
|
- ``Operations/MarkUnplayedResponse``
|
|
- ``Operations/PerformSearchResponse``
|
|
- ``Operations/PerformVoiceSearchResponse``
|
|
- ``Operations/PostUsersSignInDataResponse``
|
|
- ``Operations/StartAllTasksResponse``
|
|
- ``Operations/StartTaskResponse``
|
|
- ``Operations/StartUniversalTranscodeResponse``
|
|
- ``Operations/StopAllTasksResponse``
|
|
- ``Operations/StopTaskResponse``
|
|
- ``Operations/StopTranscodeSessionResponse``
|
|
- ``Operations/UpdatePlaylistResponse``
|
|
- ``Operations/UpdatePlayProgressResponse``
|
|
- ``Operations/UploadPlaylistResponse``
|
|
|
|
### Other models
|
|
- ``Operations/Account``
|
|
- ``Operations/Action``
|
|
- ``Operations/ActiveDirection``
|
|
- ``Operations/Activity``
|
|
- ``Operations/AddPlaylistContentsErrors``
|
|
- ``Operations/AddPlaylistContentsMediaContainer``
|
|
- ``Operations/AddPlaylistContentsMetadata``
|
|
- ``Operations/AddPlaylistContentsPlaylistsErrors``
|
|
- ``Operations/AddPlaylistContentsRequest``
|
|
- ``Operations/AddPlaylistContentsResponseBody``
|
|
- ``Operations/AddPlaylistContentsUnauthorized``
|
|
- ``Operations/ApplyUpdatesErrors``
|
|
- ``Operations/ApplyUpdatesRequest``
|
|
- ``Operations/ApplyUpdatesUnauthorized``
|
|
- ``Operations/ApplyUpdatesUpdaterErrors``
|
|
- ``Operations/AutoSelectSubtitle``
|
|
- ``Operations/Billing``
|
|
- ``Operations/ButlerTask``
|
|
- ``Operations/ButlerTasks``
|
|
- ``Operations/CancelServerActivitiesActivitiesErrors``
|
|
- ``Operations/CancelServerActivitiesErrors``
|
|
- ``Operations/CancelServerActivitiesRequest``
|
|
- ``Operations/CancelServerActivitiesUnauthorized``
|
|
- ``Operations/CheckForUpdatesErrors``
|
|
- ``Operations/CheckForUpdatesRequest``
|
|
- ``Operations/CheckForUpdatesUnauthorized``
|
|
- ``Operations/CheckForUpdatesUpdaterErrors``
|
|
- ``Operations/ClearPlaylistContentsErrors``
|
|
- ``Operations/ClearPlaylistContentsPlaylistsErrors``
|
|
- ``Operations/ClearPlaylistContentsRequest``
|
|
- ``Operations/ClearPlaylistContentsUnauthorized``
|
|
- ``Operations/Collection``
|
|
- ``Operations/Connections``
|
|
- ``Operations/Context``
|
|
- ``Operations/Country``
|
|
- ``Operations/CreatePlaylistErrors``
|
|
- ``Operations/CreatePlaylistMediaContainer``
|
|
- ``Operations/CreatePlaylistMetadata``
|
|
- ``Operations/CreatePlaylistPlaylistsErrors``
|
|
- ``Operations/CreatePlaylistQueryParamType``
|
|
- ``Operations/CreatePlaylistRequest``
|
|
- ``Operations/CreatePlaylistResponseBody``
|
|
- ``Operations/CreatePlaylistUnauthorized``
|
|
- ``Operations/DefaultDirection``
|
|
- ``Operations/DefaultSubtitleAccessibility``
|
|
- ``Operations/DefaultSubtitleForced``
|
|
- ``Operations/DeleteLibraryErrors``
|
|
- ``Operations/DeleteLibraryLibraryErrors``
|
|
- ``Operations/DeleteLibraryRequest``
|
|
- ``Operations/DeleteLibraryUnauthorized``
|
|
- ``Operations/DeletePlaylistErrors``
|
|
- ``Operations/DeletePlaylistPlaylistsErrors``
|
|
- ``Operations/DeletePlaylistRequest``
|
|
- ``Operations/DeletePlaylistUnauthorized``
|
|
- ``Operations/Device``
|
|
- ``Operations/Director``
|
|
- ``Operations/Directory``
|
|
- ``Operations/Download``
|
|
- ``Operations/EnablePaperTrailErrors``
|
|
- ``Operations/EnablePaperTrailLogErrors``
|
|
- ``Operations/EnablePaperTrailUnauthorized``
|
|
- ``Operations/Errors``
|
|
- ``Operations/Feature``
|
|
- ``Operations/Features``
|
|
- ``Operations/Field``
|
|
- ``Operations/FieldType``
|
|
- ``Operations/Filter``
|
|
- ``Operations/FlattenSeasons``
|
|
- ``Operations/Force``
|
|
- ``Operations/Friend``
|
|
- ``Operations/Genre``
|
|
- ``Operations/GeoData``
|
|
- ``Operations/GetAllLibrariesDirectory``
|
|
- ``Operations/GetAllLibrariesErrors``
|
|
- ``Operations/GetAllLibrariesLibraryErrors``
|
|
- ``Operations/GetAllLibrariesMediaContainer``
|
|
- ``Operations/GetAllLibrariesResponseBody``
|
|
- ``Operations/GetAllLibrariesUnauthorized``
|
|
- ``Operations/GetBannerImageErrors``
|
|
- ``Operations/GetBannerImageMediaErrors``
|
|
- ``Operations/GetBannerImageRequest``
|
|
- ``Operations/GetBannerImageUnauthorized``
|
|
- ``Operations/GetLibraryDetailsDirectory``
|
|
- ``Operations/GetLibraryDetailsErrors``
|
|
- ``Operations/GetLibraryDetailsFilter``
|
|
- ``Operations/GetLibraryDetailsLibraryErrors``
|
|
- ``Operations/GetLibraryDetailsMediaContainer``
|
|
- ``Operations/GetLibraryDetailsRequest``
|
|
- ``Operations/GetLibraryDetailsResponseBody``
|
|
- ``Operations/GetLibraryDetailsType``
|
|
- ``Operations/GetLibraryDetailsUnauthorized``
|
|
- ``Operations/GetLibraryItemsCountry``
|
|
- ``Operations/GetLibraryItemsDirector``
|
|
- ``Operations/GetLibraryItemsErrors``
|
|
- ``Operations/GetLibraryItemsField``
|
|
- ``Operations/GetLibraryItemsFieldType``
|
|
- ``Operations/GetLibraryItemsFilter``
|
|
- ``Operations/GetLibraryItemsGenre``
|
|
- ``Operations/GetLibraryItemsImage``
|
|
- ``Operations/GetLibraryItemsLibraryErrors``
|
|
- ``Operations/GetLibraryItemsLibraryResponseType``
|
|
- ``Operations/GetLibraryItemsLibraryType``
|
|
- ``Operations/GetLibraryItemsMedia``
|
|
- ``Operations/GetLibraryItemsMediaContainer``
|
|
- ``Operations/GetLibraryItemsMetadata``
|
|
- ``Operations/GetLibraryItemsOperator``
|
|
- ``Operations/GetLibraryItemsPart``
|
|
- ``Operations/GetLibraryItemsRequest``
|
|
- ``Operations/GetLibraryItemsResponseBody``
|
|
- ``Operations/GetLibraryItemsRole``
|
|
- ``Operations/GetLibraryItemsSort``
|
|
- ``Operations/GetLibraryItemsType``
|
|
- ``Operations/GetLibraryItemsUnauthorized``
|
|
- ``Operations/GetLibraryItemsWriter``
|
|
- ``Operations/GetMediaProvidersDirectory``
|
|
- ``Operations/GetMediaProvidersErrors``
|
|
- ``Operations/GetMediaProvidersMediaContainer``
|
|
- ``Operations/GetMediaProvidersRequest``
|
|
- ``Operations/GetMediaProvidersResponseBody``
|
|
- ``Operations/GetMediaProvidersServerErrors``
|
|
- ``Operations/GetMediaProvidersUnauthorized``
|
|
- ``Operations/GetMetaDataByRatingKeyCountry``
|
|
- ``Operations/GetMetaDataByRatingKeyDirector``
|
|
- ``Operations/GetMetaDataByRatingKeyErrors``
|
|
- ``Operations/GetMetaDataByRatingKeyGenre``
|
|
- ``Operations/GetMetaDataByRatingKeyLibraryErrors``
|
|
- ``Operations/GetMetaDataByRatingKeyMedia``
|
|
- ``Operations/GetMetaDataByRatingKeyMediaContainer``
|
|
- ``Operations/GetMetaDataByRatingKeyMetadata``
|
|
- ``Operations/GetMetaDataByRatingKeyPart``
|
|
- ``Operations/GetMetaDataByRatingKeyRequest``
|
|
- ``Operations/GetMetaDataByRatingKeyResponseBody``
|
|
- ``Operations/GetMetaDataByRatingKeyRole``
|
|
- ``Operations/GetMetaDataByRatingKeyUnauthorized``
|
|
- ``Operations/GetMetaDataByRatingKeyWriter``
|
|
- ``Operations/GetRefreshLibraryMetadataErrors``
|
|
- ``Operations/GetRefreshLibraryMetadataLibraryErrors``
|
|
- ``Operations/GetRefreshLibraryMetadataRequest``
|
|
- ``Operations/GetRefreshLibraryMetadataUnauthorized``
|
|
- ``Operations/GetSearchLibraryErrors``
|
|
- ``Operations/GetSearchLibraryLibraryErrors``
|
|
- ``Operations/GetSearchLibraryMediaContainer``
|
|
- ``Operations/GetSearchLibraryMetadata``
|
|
- ``Operations/GetSearchLibraryRequest``
|
|
- ``Operations/GetSearchLibraryResponseBody``
|
|
- ``Operations/GetSearchLibraryUnauthorized``
|
|
- ``Operations/GetServerIdentityMediaContainer``
|
|
- ``Operations/GetServerIdentityRequestTimeout``
|
|
- ``Operations/GetServerIdentityResponseBody``
|
|
- ``Operations/GetServerResourcesErrors``
|
|
- ``Operations/GetServerResourcesPlexErrors``
|
|
- ``Operations/GetServerResourcesRequest``
|
|
- ``Operations/GetServerResourcesUnauthorized``
|
|
- ``Operations/GetThumbImageErrors``
|
|
- ``Operations/GetThumbImageMediaErrors``
|
|
- ``Operations/GetThumbImageRequest``
|
|
- ``Operations/GetThumbImageUnauthorized``
|
|
- ``Operations/GetWatchListErrors``
|
|
- ``Operations/GetWatchListRequest``
|
|
- ``Operations/GetWatchListResponseBody``
|
|
- ``Operations/GetWatchListUnauthorized``
|
|
- ``Operations/GetWatchListWatchlistErrors``
|
|
- ``Operations/GetAvailableClientsErrors``
|
|
- ``Operations/GetAvailableClientsMediaContainer``
|
|
- ``Operations/GetAvailableClientsResponseBody``
|
|
- ``Operations/GetAvailableClientsServerErrors``
|
|
- ``Operations/GetAvailableClientsUnauthorized``
|
|
- ``Operations/GetBandwidthStatisticsAccount``
|
|
- ``Operations/GetBandwidthStatisticsDevice``
|
|
- ``Operations/GetBandwidthStatisticsErrors``
|
|
- ``Operations/GetBandwidthStatisticsMediaContainer``
|
|
- ``Operations/GetBandwidthStatisticsRequest``
|
|
- ``Operations/GetBandwidthStatisticsResponseBody``
|
|
- ``Operations/GetBandwidthStatisticsStatisticsErrors``
|
|
- ``Operations/GetBandwidthStatisticsUnauthorized``
|
|
- ``Operations/GetButlerTasksButlerErrors``
|
|
- ``Operations/GetButlerTasksErrors``
|
|
- ``Operations/GetButlerTasksResponseBody``
|
|
- ``Operations/GetButlerTasksUnauthorized``
|
|
- ``Operations/GetCompanionsDataErrors``
|
|
- ``Operations/GetCompanionsDataPlexErrors``
|
|
- ``Operations/GetCompanionsDataUnauthorized``
|
|
- ``Operations/GetDevicesErrors``
|
|
- ``Operations/GetDevicesMediaContainer``
|
|
- ``Operations/GetDevicesResponseBody``
|
|
- ``Operations/GetDevicesServerErrors``
|
|
- ``Operations/GetDevicesUnauthorized``
|
|
- ``Operations/GetFileHashErrors``
|
|
- ``Operations/GetFileHashLibraryErrors``
|
|
- ``Operations/GetFileHashRequest``
|
|
- ``Operations/GetFileHashUnauthorized``
|
|
- ``Operations/GetGeoDataErrors``
|
|
- ``Operations/GetGeoDataGeoData``
|
|
- ``Operations/GetGeoDataPlexErrors``
|
|
- ``Operations/GetGeoDataUnauthorized``
|
|
- ``Operations/GetGlobalHubsErrors``
|
|
- ``Operations/GetGlobalHubsHubsErrors``
|
|
- ``Operations/GetGlobalHubsMediaContainer``
|
|
- ``Operations/GetGlobalHubsMetadata``
|
|
- ``Operations/GetGlobalHubsRequest``
|
|
- ``Operations/GetGlobalHubsResponseBody``
|
|
- ``Operations/GetGlobalHubsUnauthorized``
|
|
- ``Operations/GetHomeDataErrors``
|
|
- ``Operations/GetHomeDataPlexErrors``
|
|
- ``Operations/GetHomeDataResponseBody``
|
|
- ``Operations/GetHomeDataUnauthorized``
|
|
- ``Operations/GetLibraryHubsCountry``
|
|
- ``Operations/GetLibraryHubsDirector``
|
|
- ``Operations/GetLibraryHubsErrors``
|
|
- ``Operations/GetLibraryHubsGenre``
|
|
- ``Operations/GetLibraryHubsHub``
|
|
- ``Operations/GetLibraryHubsHubsErrors``
|
|
- ``Operations/GetLibraryHubsMedia``
|
|
- ``Operations/GetLibraryHubsMediaContainer``
|
|
- ``Operations/GetLibraryHubsMetadata``
|
|
- ``Operations/GetLibraryHubsPart``
|
|
- ``Operations/GetLibraryHubsRequest``
|
|
- ``Operations/GetLibraryHubsResponseBody``
|
|
- ``Operations/GetLibraryHubsRole``
|
|
- ``Operations/GetLibraryHubsUnauthorized``
|
|
- ``Operations/GetLibraryHubsWriter``
|
|
- ``Operations/GetMetadataChildrenDirectory``
|
|
- ``Operations/GetMetadataChildrenErrors``
|
|
- ``Operations/GetMetadataChildrenLibraryErrors``
|
|
- ``Operations/GetMetadataChildrenMediaContainer``
|
|
- ``Operations/GetMetadataChildrenMetadata``
|
|
- ``Operations/GetMetadataChildrenRequest``
|
|
- ``Operations/GetMetadataChildrenResponseBody``
|
|
- ``Operations/GetMetadataChildrenUnauthorized``
|
|
- ``Operations/GetMyPlexAccountErrors``
|
|
- ``Operations/GetMyPlexAccountResponseBody``
|
|
- ``Operations/GetMyPlexAccountServerErrors``
|
|
- ``Operations/GetMyPlexAccountUnauthorized``
|
|
- ``Operations/GetOnDeckErrors``
|
|
- ``Operations/GetOnDeckGuids``
|
|
- ``Operations/GetOnDeckLibraryErrors``
|
|
- ``Operations/GetOnDeckMedia``
|
|
- ``Operations/GetOnDeckMediaContainer``
|
|
- ``Operations/GetOnDeckMetadata``
|
|
- ``Operations/GetOnDeckPart``
|
|
- ``Operations/GetOnDeckResponseBody``
|
|
- ``Operations/GetOnDeckStream``
|
|
- ``Operations/GetOnDeckUnauthorized``
|
|
- ``Operations/GetPinAuthPinContainer``
|
|
- ``Operations/GetPinErrors``
|
|
- ``Operations/GetPinRequest``
|
|
- ``Operations/GetPlaylistErrors``
|
|
- ``Operations/GetPlaylistMediaContainer``
|
|
- ``Operations/GetPlaylistMetadata``
|
|
- ``Operations/GetPlaylistPlaylistsErrors``
|
|
- ``Operations/GetPlaylistRequest``
|
|
- ``Operations/GetPlaylistResponseBody``
|
|
- ``Operations/GetPlaylistUnauthorized``
|
|
- ``Operations/GetPlaylistContentsCountry``
|
|
- ``Operations/GetPlaylistContentsDirector``
|
|
- ``Operations/GetPlaylistContentsErrors``
|
|
- ``Operations/GetPlaylistContentsGenre``
|
|
- ``Operations/GetPlaylistContentsMedia``
|
|
- ``Operations/GetPlaylistContentsMediaContainer``
|
|
- ``Operations/GetPlaylistContentsMetadata``
|
|
- ``Operations/GetPlaylistContentsPart``
|
|
- ``Operations/GetPlaylistContentsPlaylistsErrors``
|
|
- ``Operations/GetPlaylistContentsQueryParamType``
|
|
- ``Operations/GetPlaylistContentsRequest``
|
|
- ``Operations/GetPlaylistContentsResponseBody``
|
|
- ``Operations/GetPlaylistContentsRole``
|
|
- ``Operations/GetPlaylistContentsUnauthorized``
|
|
- ``Operations/GetPlaylistContentsWriter``
|
|
- ``Operations/GetPlaylistsErrors``
|
|
- ``Operations/GetPlaylistsMediaContainer``
|
|
- ``Operations/GetPlaylistsMetadata``
|
|
- ``Operations/GetPlaylistsPlaylistsErrors``
|
|
- ``Operations/GetPlaylistsRequest``
|
|
- ``Operations/GetPlaylistsResponseBody``
|
|
- ``Operations/GetPlaylistsUnauthorized``
|
|
- ``Operations/GetRecentlyAddedErrors``
|
|
- ``Operations/GetRecentlyAddedLibraryErrors``
|
|
- ``Operations/GetRecentlyAddedMediaContainer``
|
|
- ``Operations/GetRecentlyAddedMetadata``
|
|
- ``Operations/GetRecentlyAddedRequest``
|
|
- ``Operations/GetRecentlyAddedResponseBody``
|
|
- ``Operations/GetRecentlyAddedUnauthorized``
|
|
- ``Operations/GetResizedPhotoErrors``
|
|
- ``Operations/GetResizedPhotoRequest``
|
|
- ``Operations/GetResizedPhotoServerErrors``
|
|
- ``Operations/GetResizedPhotoUnauthorized``
|
|
- ``Operations/GetResourcesStatisticsErrors``
|
|
- ``Operations/GetResourcesStatisticsMediaContainer``
|
|
- ``Operations/GetResourcesStatisticsRequest``
|
|
- ``Operations/GetResourcesStatisticsResponseBody``
|
|
- ``Operations/GetResourcesStatisticsStatisticsErrors``
|
|
- ``Operations/GetResourcesStatisticsUnauthorized``
|
|
- ``Operations/GetSearchResultsCountry``
|
|
- ``Operations/GetSearchResultsDirector``
|
|
- ``Operations/GetSearchResultsErrors``
|
|
- ``Operations/GetSearchResultsGenre``
|
|
- ``Operations/GetSearchResultsMedia``
|
|
- ``Operations/GetSearchResultsMediaContainer``
|
|
- ``Operations/GetSearchResultsMetadata``
|
|
- ``Operations/GetSearchResultsPart``
|
|
- ``Operations/GetSearchResultsRequest``
|
|
- ``Operations/GetSearchResultsResponseBody``
|
|
- ``Operations/GetSearchResultsRole``
|
|
- ``Operations/GetSearchResultsSearchErrors``
|
|
- ``Operations/GetSearchResultsUnauthorized``
|
|
- ``Operations/GetSearchResultsWriter``
|
|
- ``Operations/GetServerActivitiesActivitiesErrors``
|
|
- ``Operations/GetServerActivitiesErrors``
|
|
- ``Operations/GetServerActivitiesMediaContainer``
|
|
- ``Operations/GetServerActivitiesResponseBody``
|
|
- ``Operations/GetServerActivitiesUnauthorized``
|
|
- ``Operations/GetServerCapabilitiesErrors``
|
|
- ``Operations/GetServerCapabilitiesResponseBody``
|
|
- ``Operations/GetServerCapabilitiesUnauthorized``
|
|
- ``Operations/GetServerListErrors``
|
|
- ``Operations/GetServerListMediaContainer``
|
|
- ``Operations/GetServerListResponseBody``
|
|
- ``Operations/GetServerListServer``
|
|
- ``Operations/GetServerListServerErrors``
|
|
- ``Operations/GetServerListUnauthorized``
|
|
- ``Operations/GetServerPreferencesErrors``
|
|
- ``Operations/GetServerPreferencesMediaContainer``
|
|
- ``Operations/GetServerPreferencesResponseBody``
|
|
- ``Operations/GetServerPreferencesServerErrors``
|
|
- ``Operations/GetServerPreferencesUnauthorized``
|
|
- ``Operations/GetSessionHistoryErrors``
|
|
- ``Operations/GetSessionHistoryMediaContainer``
|
|
- ``Operations/GetSessionHistoryMetadata``
|
|
- ``Operations/GetSessionHistoryRequest``
|
|
- ``Operations/GetSessionHistoryResponseBody``
|
|
- ``Operations/GetSessionHistorySessionsErrors``
|
|
- ``Operations/GetSessionHistoryUnauthorized``
|
|
- ``Operations/GetSessionsErrors``
|
|
- ``Operations/GetSessionsMedia``
|
|
- ``Operations/GetSessionsMediaContainer``
|
|
- ``Operations/GetSessionsMetadata``
|
|
- ``Operations/GetSessionsPart``
|
|
- ``Operations/GetSessionsResponseBody``
|
|
- ``Operations/GetSessionsSessionsErrors``
|
|
- ``Operations/GetSessionsStream``
|
|
- ``Operations/GetSessionsUnauthorized``
|
|
- ``Operations/GetSessionsUser``
|
|
- ``Operations/GetSourceConnectionInformationAuthenticationErrors``
|
|
- ``Operations/GetSourceConnectionInformationErrors``
|
|
- ``Operations/GetSourceConnectionInformationRequest``
|
|
- ``Operations/GetSourceConnectionInformationUnauthorized``
|
|
- ``Operations/GetStatisticsDevice``
|
|
- ``Operations/GetStatisticsErrors``
|
|
- ``Operations/GetStatisticsMediaContainer``
|
|
- ``Operations/GetStatisticsRequest``
|
|
- ``Operations/GetStatisticsResponseBody``
|
|
- ``Operations/GetStatisticsStatisticsErrors``
|
|
- ``Operations/GetStatisticsUnauthorized``
|
|
- ``Operations/GetTimelineErrors``
|
|
- ``Operations/GetTimelineRequest``
|
|
- ``Operations/GetTimelineUnauthorized``
|
|
- ``Operations/GetTimelineVideoErrors``
|
|
- ``Operations/GetTokenByPinIdAuthPinContainer``
|
|
- ``Operations/GetTokenByPinIdErrors``
|
|
- ``Operations/GetTokenByPinIdGeoData``
|
|
- ``Operations/GetTokenByPinIdPlexErrors``
|
|
- ``Operations/GetTokenByPinIdRequest``
|
|
- ``Operations/GetTokenByPinIdResponseBody``
|
|
- ``Operations/GetTokenDetailsAuthenticationErrors``
|
|
- ``Operations/GetTokenDetailsAuthenticationResponseStatus``
|
|
- ``Operations/GetTokenDetailsAuthenticationStatus``
|
|
- ``Operations/GetTokenDetailsErrors``
|
|
- ``Operations/GetTokenDetailsFeatures``
|
|
- ``Operations/GetTokenDetailsStatus``
|
|
- ``Operations/GetTokenDetailsSubscription``
|
|
- ``Operations/GetTokenDetailsUnauthorized``
|
|
- ``Operations/GetTokenDetailsUserPlexAccount``
|
|
- ``Operations/GetTopWatchedContentCountry``
|
|
- ``Operations/GetTopWatchedContentErrors``
|
|
- ``Operations/GetTopWatchedContentGenre``
|
|
- ``Operations/GetTopWatchedContentGuids``
|
|
- ``Operations/GetTopWatchedContentLibraryErrors``
|
|
- ``Operations/GetTopWatchedContentMediaContainer``
|
|
- ``Operations/GetTopWatchedContentMetadata``
|
|
- ``Operations/GetTopWatchedContentQueryParamType``
|
|
- ``Operations/GetTopWatchedContentRequest``
|
|
- ``Operations/GetTopWatchedContentResponseBody``
|
|
- ``Operations/GetTopWatchedContentRole``
|
|
- ``Operations/GetTopWatchedContentUnauthorized``
|
|
- ``Operations/GetTranscodeSessionsErrors``
|
|
- ``Operations/GetTranscodeSessionsMediaContainer``
|
|
- ``Operations/GetTranscodeSessionsResponseBody``
|
|
- ``Operations/GetTranscodeSessionsSessionsErrors``
|
|
- ``Operations/GetTranscodeSessionsUnauthorized``
|
|
- ``Operations/GetTransientTokenAuthenticationErrors``
|
|
- ``Operations/GetTransientTokenErrors``
|
|
- ``Operations/GetTransientTokenQueryParamType``
|
|
- ``Operations/GetTransientTokenRequest``
|
|
- ``Operations/GetTransientTokenUnauthorized``
|
|
- ``Operations/GetUpdateStatusErrors``
|
|
- ``Operations/GetUpdateStatusMediaContainer``
|
|
- ``Operations/GetUpdateStatusResponseBody``
|
|
- ``Operations/GetUpdateStatusUnauthorized``
|
|
- ``Operations/GetUpdateStatusUpdaterErrors``
|
|
- ``Operations/GetUserFriendsErrors``
|
|
- ``Operations/GetUserFriendsPlexErrors``
|
|
- ``Operations/GetUserFriendsUnauthorized``
|
|
- ``Operations/Guids``
|
|
- ``Operations/HasThumbnail``
|
|
- ``Operations/Hub``
|
|
- ``Operations/Image``
|
|
- ``Operations/IncludeCollections``
|
|
- ``Operations/IncludeDetails``
|
|
- ``Operations/IncludeExternalMedia``
|
|
- ``Operations/IncludeGuids``
|
|
- ``Operations/IncludeHttps``
|
|
- ``Operations/IncludeIPv6``
|
|
- ``Operations/IncludeMeta``
|
|
- ``Operations/IncludeRelay``
|
|
- ``Operations/InternalPaymentMethod``
|
|
- ``Operations/Level``
|
|
- ``Operations/LibrarySectionID``
|
|
- ``Operations/Libtype``
|
|
- ``Operations/Location``
|
|
- ``Operations/LogLineErrors``
|
|
- ``Operations/LogLineLogErrors``
|
|
- ``Operations/LogLineRequest``
|
|
- ``Operations/LogLineUnauthorized``
|
|
- ``Operations/LogMultiLineErrors``
|
|
- ``Operations/LogMultiLineLogErrors``
|
|
- ``Operations/LogMultiLineUnauthorized``
|
|
- ``Operations/MailingListStatus``
|
|
- ``Operations/MarkPlayedErrors``
|
|
- ``Operations/MarkPlayedMediaErrors``
|
|
- ``Operations/MarkPlayedRequest``
|
|
- ``Operations/MarkPlayedUnauthorized``
|
|
- ``Operations/MarkUnplayedErrors``
|
|
- ``Operations/MarkUnplayedMediaErrors``
|
|
- ``Operations/MarkUnplayedRequest``
|
|
- ``Operations/MarkUnplayedUnauthorized``
|
|
- ``Operations/Media``
|
|
- ``Operations/MediaContainer``
|
|
- ``Operations/MediaGuid``
|
|
- ``Operations/MediaProvider``
|
|
- ``Operations/MediaReviewsVisibility``
|
|
- ``Operations/Meta``
|
|
- ``Operations/Metadata``
|
|
- ``Operations/MinSize``
|
|
- ``Operations/MyPlex``
|
|
- ``Operations/OnlyTransient``
|
|
- ``Operations/Operator``
|
|
- ``Operations/Part``
|
|
- ``Operations/PastSubscription``
|
|
- ``Operations/PathParamTaskName``
|
|
- ``Operations/PerformSearchErrors``
|
|
- ``Operations/PerformSearchRequest``
|
|
- ``Operations/PerformSearchSearchErrors``
|
|
- ``Operations/PerformSearchUnauthorized``
|
|
- ``Operations/PerformVoiceSearchErrors``
|
|
- ``Operations/PerformVoiceSearchRequest``
|
|
- ``Operations/PerformVoiceSearchSearchErrors``
|
|
- ``Operations/PerformVoiceSearchUnauthorized``
|
|
- ``Operations/Pivot``
|
|
- ``Operations/Player``
|
|
- ``Operations/PlaylistType``
|
|
- ``Operations/PlexDevice``
|
|
- ``Operations/PostUsersSignInDataAuthenticationErrors``
|
|
- ``Operations/PostUsersSignInDataAuthenticationFeatures``
|
|
- ``Operations/PostUsersSignInDataAuthenticationResponseStatus``
|
|
- ``Operations/PostUsersSignInDataAuthenticationStatus``
|
|
- ``Operations/PostUsersSignInDataAuthenticationSubscription``
|
|
- ``Operations/PostUsersSignInDataAutoSelectSubtitle``
|
|
- ``Operations/PostUsersSignInDataDefaultSubtitleAccessibility``
|
|
- ``Operations/PostUsersSignInDataDefaultSubtitleForced``
|
|
- ``Operations/PostUsersSignInDataErrors``
|
|
- ``Operations/PostUsersSignInDataFeatures``
|
|
- ``Operations/PostUsersSignInDataMailingListStatus``
|
|
- ``Operations/PostUsersSignInDataMediaReviewsVisibility``
|
|
- ``Operations/PostUsersSignInDataRequestBody``
|
|
- ``Operations/PostUsersSignInDataServices``
|
|
- ``Operations/PostUsersSignInDataState``
|
|
- ``Operations/PostUsersSignInDataStatus``
|
|
- ``Operations/PostUsersSignInDataSubscription``
|
|
- ``Operations/PostUsersSignInDataUnauthorized``
|
|
- ``Operations/PostUsersSignInDataUserPlexAccount``
|
|
- ``Operations/PostUsersSignInDataUserProfile``
|
|
- ``Operations/PostUsersSignInDataWatchedIndicator``
|
|
- ``Operations/Producer``
|
|
- ``Operations/`Protocol```
|
|
- ``Operations/Provider``
|
|
- ``Operations/QueryParamFilter``
|
|
- ``Operations/QueryParamForce``
|
|
- ``Operations/QueryParamOnlyTransient``
|
|
- ``Operations/QueryParamSmart``
|
|
- ``Operations/QueryParamType``
|
|
- ``Operations/Ratings``
|
|
- ``Operations/Release``
|
|
- ``Operations/ResponseBody``
|
|
- ``Operations/Role``
|
|
- ``Operations/Scope``
|
|
- ``Operations/Server``
|
|
- ``Operations/Services``
|
|
- ``Operations/Session``
|
|
- ``Operations/Setting``
|
|
- ``Operations/SharedServers``
|
|
- ``Operations/SharedSources``
|
|
- ``Operations/ShowOrdering``
|
|
- ``Operations/Skip``
|
|
- ``Operations/Smart``
|
|
- ``Operations/Sort``
|
|
- ``Operations/StartAllTasksButlerErrors``
|
|
- ``Operations/StartAllTasksErrors``
|
|
- ``Operations/StartAllTasksUnauthorized``
|
|
- ``Operations/StartTaskButlerErrors``
|
|
- ``Operations/StartTaskErrors``
|
|
- ``Operations/StartTaskRequest``
|
|
- ``Operations/StartTaskUnauthorized``
|
|
- ``Operations/StartUniversalTranscodeErrors``
|
|
- ``Operations/StartUniversalTranscodeRequest``
|
|
- ``Operations/StartUniversalTranscodeUnauthorized``
|
|
- ``Operations/StartUniversalTranscodeVideoErrors``
|
|
- ``Operations/State``
|
|
- ``Operations/StatisticsBandwidth``
|
|
- ``Operations/StatisticsMedia``
|
|
- ``Operations/StatisticsResources``
|
|
- ``Operations/Status``
|
|
- ``Operations/StopAllTasksButlerErrors``
|
|
- ``Operations/StopAllTasksErrors``
|
|
- ``Operations/StopAllTasksUnauthorized``
|
|
- ``Operations/StopTaskButlerErrors``
|
|
- ``Operations/StopTaskErrors``
|
|
- ``Operations/StopTaskRequest``
|
|
- ``Operations/StopTaskUnauthorized``
|
|
- ``Operations/StopTranscodeSessionErrors``
|
|
- ``Operations/StopTranscodeSessionRequest``
|
|
- ``Operations/StopTranscodeSessionSessionsErrors``
|
|
- ``Operations/StopTranscodeSessionUnauthorized``
|
|
- ``Operations/Stream``
|
|
- ``Operations/Subscription``
|
|
- ``Operations/Tag``
|
|
- ``Operations/TaskName``
|
|
- ``Operations/Tonight``
|
|
- ``Operations/TranscodeSession``
|
|
- ``Operations/Trials``
|
|
- ``Operations/TypeModel``
|
|
- ``Operations/UltraBlurColors``
|
|
- ``Operations/UpdatePlaylistErrors``
|
|
- ``Operations/UpdatePlaylistPlaylistsErrors``
|
|
- ``Operations/UpdatePlaylistRequest``
|
|
- ``Operations/UpdatePlaylistUnauthorized``
|
|
- ``Operations/UpdatePlayProgressErrors``
|
|
- ``Operations/UpdatePlayProgressMediaErrors``
|
|
- ``Operations/UpdatePlayProgressRequest``
|
|
- ``Operations/UpdatePlayProgressUnauthorized``
|
|
- ``Operations/UploadPlaylistErrors``
|
|
- ``Operations/UploadPlaylistPlaylistsErrors``
|
|
- ``Operations/UploadPlaylistRequest``
|
|
- ``Operations/UploadPlaylistUnauthorized``
|
|
- ``Operations/Upscale``
|
|
- ``Operations/User``
|
|
- ``Operations/UserProfile``
|
|
- ``Operations/WatchedIndicator``
|
|
- ``Operations/Writer``
|
|
|
|
### Type groupings
|
|
- ``Operations``
|
|
- ``Shared``
|
|
|
|
### Data types
|
|
|
|
- ``AnyValue``
|
|
- ``APIValue``
|
|
|
|
### Internal data types
|
|
|
|
- ``DateConvertible``
|
|
- ``DateOnly``
|
|
- ``DateTime``
|
|
- ``DecimalSerialized``
|
|
- ``DoubleConvertible``
|