mirror of
https://github.com/LukeHagar/plexswift.git
synced 2025-12-06 12:47:44 +00:00
14 KiB
14 KiB
plexswift
An Open API Spec for interacting with Plex.tv and Plex Servers
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
import Foundation
import Plexswift
let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))
let response = try await client.server.getServerCapabilities()
switch response.data {
case .twoHundredApplicationJsonObject(let twoHundredApplicationJsonObject):
// Handle response
break
case .fourHundredAndOneApplicationJsonObject(let fourHundredAndOneApplicationJsonObject):
// Handle response
break
case .empty:
// Handle empty response
break
}
Getting started
PlexswiftAPIdefines the available API operations, including operations which are logically grouped by name (for example underPlexswiftAPI/server).Clientis the main object used when making requests to the API, and implementsPlexswiftAPIto provide this functionality. Each available API method is exposed as anasyncfunction, which you can call andawaitits 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
Clientwith aShared/Securityvalue. - If an error occurs when making a request to the API, a
PlexswiftErrorerror is thrown with more information about what went wrong.
Topics
Connecting to the API
ClientShared/SecurityResponseResponseWithHeadersResponseFieldsResponseHeadersPlexswiftError
API operations
plexswift/PlexswiftAPIServerAPIMediaAPIActivitiesAPIButlerAPIHubsAPISearchAPILibraryAPILogAPIPlaylistsAPISecurityAPISessionsAPIUpdaterAPIVideoAPI
Server configuration
Shared models
Request objects
Response objects
Operations/AddPlaylistContentsResponseOperations/ApplyUpdatesResponseOperations/CancelServerActivitiesResponseOperations/CheckForUpdatesResponseOperations/ClearPlaylistContentsResponseOperations/CreatePlaylistResponseOperations/DeleteLibraryResponseOperations/DeletePlaylistResponseOperations/EnablePaperTrailResponseOperations/GetAvailableClientsResponseOperations/GetButlerTasksResponseOperations/GetCommonLibraryItemsResponseOperations/GetDevicesResponseOperations/GetFileHashResponseOperations/GetGlobalHubsResponseOperations/GetLatestLibraryItemsResponseOperations/GetLibrariesResponseOperations/GetLibraryResponseOperations/GetLibraryHubsResponseOperations/GetLibraryItemsResponseOperations/GetMetadataResponseOperations/GetMetadataChildrenResponseOperations/GetMyPlexAccountResponseOperations/GetOnDeckResponseOperations/GetPlaylistResponseOperations/GetPlaylistContentsResponseOperations/GetPlaylistsResponseOperations/GetRecentlyAddedResponseOperations/GetResizedPhotoResponseOperations/GetSearchResultsResponseOperations/GetServerActivitiesResponseOperations/GetServerCapabilitiesResponseOperations/GetServerIdentityResponseOperations/GetServerListResponseOperations/GetServerPreferencesResponseOperations/GetSessionHistoryResponseOperations/GetSessionsResponseOperations/GetSourceConnectionInformationResponseOperations/GetTimelineResponseOperations/GetTranscodeSessionsResponseOperations/GetTransientTokenResponseOperations/GetUpdateStatusResponseOperations/LogLineResponseOperations/LogMultiLineResponseOperations/MarkPlayedResponseOperations/MarkUnplayedResponseOperations/PerformSearchResponseOperations/PerformVoiceSearchResponseOperations/RefreshLibraryResponseOperations/StartAllTasksResponseOperations/StartTaskResponseOperations/StartUniversalTranscodeResponseOperations/StopAllTasksResponseOperations/StopTaskResponseOperations/StopTranscodeSessionResponseOperations/UpdatePlaylistResponseOperations/UpdatePlayProgressResponseOperations/UploadPlaylistResponse
Other models
Operations/ActivityOperations/AddPlaylistContentsErrorsOperations/AddPlaylistContentsRequestOperations/AddPlaylistContentsResponseBodyOperations/ApplyUpdatesErrorsOperations/ApplyUpdatesRequestOperations/ApplyUpdatesResponseBodyOperations/ButlerTaskOperations/ButlerTasksOperations/CancelServerActivitiesErrorsOperations/CancelServerActivitiesRequestOperations/CancelServerActivitiesResponseBodyOperations/CheckForUpdatesErrorsOperations/CheckForUpdatesRequestOperations/CheckForUpdatesResponseBodyOperations/ClearPlaylistContentsErrorsOperations/ClearPlaylistContentsRequestOperations/ClearPlaylistContentsResponseBodyOperations/ContextOperations/CountryOperations/CreatePlaylistErrorsOperations/CreatePlaylistRequestOperations/CreatePlaylistResponseBodyOperations/DeleteLibraryErrorsOperations/DeleteLibraryRequestOperations/DeleteLibraryResponseBodyOperations/DeletePlaylistErrorsOperations/DeletePlaylistRequestOperations/DeletePlaylistResponseBodyOperations/DeviceOperations/DirectorOperations/DirectoryOperations/DownloadOperations/EnablePaperTrailErrorsOperations/EnablePaperTrailResponseBodyOperations/ErrorsOperations/ForceOperations/GenreOperations/GetAvailableClientsErrorsOperations/GetAvailableClientsMediaContainerOperations/GetAvailableClientsResponseBodyOperations/GetButlerTasksButlerResponseBodyOperations/GetButlerTasksErrorsOperations/GetButlerTasksResponseBodyOperations/GetCommonLibraryItemsErrorsOperations/GetCommonLibraryItemsRequestOperations/GetCommonLibraryItemsResponseBodyOperations/GetDevicesErrorsOperations/GetDevicesMediaContainerOperations/GetDevicesResponseBodyOperations/GetDevicesServerResponseBodyOperations/GetFileHashErrorsOperations/GetFileHashRequestOperations/GetFileHashResponseBodyOperations/GetGlobalHubsErrorsOperations/GetGlobalHubsRequestOperations/GetGlobalHubsResponseBodyOperations/GetLatestLibraryItemsErrorsOperations/GetLatestLibraryItemsRequestOperations/GetLatestLibraryItemsResponseBodyOperations/GetLibrariesErrorsOperations/GetLibrariesResponseBodyOperations/GetLibraryErrorsOperations/GetLibraryRequestOperations/GetLibraryResponseBodyOperations/GetLibraryHubsErrorsOperations/GetLibraryHubsRequestOperations/GetLibraryHubsResponseBodyOperations/GetLibraryItemsErrorsOperations/GetLibraryItemsRequestOperations/GetLibraryItemsResponseBodyOperations/GetMetadataErrorsOperations/GetMetadataRequestOperations/GetMetadataResponseBodyOperations/GetMetadataChildrenErrorsOperations/GetMetadataChildrenRequestOperations/GetMetadataChildrenResponseBodyOperations/GetMyPlexAccountErrorsOperations/GetMyPlexAccountResponseBodyOperations/GetMyPlexAccountServerResponseBodyOperations/GetOnDeckErrorsOperations/GetOnDeckLibraryResponseBodyOperations/GetOnDeckMediaOperations/GetOnDeckMediaContainerOperations/GetOnDeckMetadataOperations/GetOnDeckPartOperations/GetOnDeckResponseBodyOperations/GetPlaylistErrorsOperations/GetPlaylistRequestOperations/GetPlaylistResponseBodyOperations/GetPlaylistContentsErrorsOperations/GetPlaylistContentsRequestOperations/GetPlaylistContentsResponseBodyOperations/GetPlaylistsErrorsOperations/GetPlaylistsRequestOperations/GetPlaylistsResponseBodyOperations/GetRecentlyAddedErrorsOperations/GetRecentlyAddedLibraryResponseBodyOperations/GetRecentlyAddedMediaContainerOperations/GetRecentlyAddedResponseBodyOperations/GetResizedPhotoErrorsOperations/GetResizedPhotoRequestOperations/GetResizedPhotoResponseBodyOperations/GetSearchResultsCountryOperations/GetSearchResultsDirectorOperations/GetSearchResultsErrorsOperations/GetSearchResultsGenreOperations/GetSearchResultsMediaOperations/GetSearchResultsMediaContainerOperations/GetSearchResultsMetadataOperations/GetSearchResultsPartOperations/GetSearchResultsRequestOperations/GetSearchResultsResponseBodyOperations/GetSearchResultsRoleOperations/GetSearchResultsSearchResponseBodyOperations/GetSearchResultsWriterOperations/GetServerActivitiesActivitiesResponseBodyOperations/GetServerActivitiesErrorsOperations/GetServerActivitiesMediaContainerOperations/GetServerActivitiesResponseBodyOperations/GetServerCapabilitiesResponseBodyOperations/GetServerCapabilitiesServerResponseBodyOperations/GetServerIdentityErrorsOperations/GetServerIdentityMediaContainerOperations/GetServerIdentityResponseBodyOperations/GetServerIdentityServerResponseBodyOperations/GetServerListErrorsOperations/GetServerListMediaContainerOperations/GetServerListResponseBodyOperations/GetServerListServerOperations/GetServerListServerResponseBodyOperations/GetServerPreferencesErrorsOperations/GetServerPreferencesResponseBodyOperations/GetSessionHistoryErrorsOperations/GetSessionHistoryResponseBodyOperations/GetSessionsErrorsOperations/GetSessionsResponseBodyOperations/GetSourceConnectionInformationErrorsOperations/GetSourceConnectionInformationRequestOperations/GetSourceConnectionInformationResponseBodyOperations/GetTimelineErrorsOperations/GetTimelineRequestOperations/GetTimelineResponseBodyOperations/GetTranscodeSessionsErrorsOperations/GetTranscodeSessionsMediaContainerOperations/GetTranscodeSessionsResponseBodyOperations/GetTranscodeSessionsSessionsResponseBodyOperations/GetTransientTokenErrorsOperations/GetTransientTokenRequestOperations/GetTransientTokenResponseBodyOperations/GetUpdateStatusErrorsOperations/GetUpdateStatusResponseBodyOperations/GuidsOperations/IncludeDetailsOperations/LevelOperations/LogLineErrorsOperations/LogLineRequestOperations/LogLineResponseBodyOperations/LogMultiLineErrorsOperations/LogMultiLineResponseBodyOperations/MarkPlayedErrorsOperations/MarkPlayedRequestOperations/MarkPlayedResponseBodyOperations/MarkUnplayedErrorsOperations/MarkUnplayedRequestOperations/MarkUnplayedResponseBodyOperations/MediaOperations/MediaContainerOperations/MetadataOperations/MinSizeOperations/MyPlexOperations/OnlyTransientOperations/PartOperations/PathParamTaskNameOperations/PerformSearchErrorsOperations/PerformSearchRequestOperations/PerformSearchResponseBodyOperations/PerformVoiceSearchErrorsOperations/PerformVoiceSearchRequestOperations/PerformVoiceSearchResponseBodyOperations/PlaylistTypeOperations/ProviderOperations/QueryParamOnlyTransientOperations/QueryParamSmartOperations/QueryParamTypeOperations/RefreshLibraryErrorsOperations/RefreshLibraryRequestOperations/RefreshLibraryResponseBodyOperations/ResponseBodyOperations/RoleOperations/ScopeOperations/ServerOperations/SkipOperations/SmartOperations/StartAllTasksErrorsOperations/StartAllTasksResponseBodyOperations/StartTaskErrorsOperations/StartTaskRequestOperations/StartTaskResponseBodyOperations/StartUniversalTranscodeErrorsOperations/StartUniversalTranscodeRequestOperations/StartUniversalTranscodeResponseBodyOperations/StateOperations/StopAllTasksErrorsOperations/StopAllTasksResponseBodyOperations/StopTaskErrorsOperations/StopTaskRequestOperations/StopTaskResponseBodyOperations/StopTranscodeSessionErrorsOperations/StopTranscodeSessionRequestOperations/StopTranscodeSessionResponseBodyOperations/StreamOperations/TaskNameOperations/TonightOperations/TranscodeSessionOperations/TypeModelOperations/UpdatePlaylistErrorsOperations/UpdatePlaylistRequestOperations/UpdatePlaylistResponseBodyOperations/UpdatePlayProgressErrorsOperations/UpdatePlayProgressRequestOperations/UpdatePlayProgressResponseBodyOperations/UploadPlaylistErrorsOperations/UploadPlaylistRequestOperations/UploadPlaylistResponseBodyOperations/UpscaleOperations/Writer
Type groupings
OperationsShared
Data types
AnyValueAPIValue
Internal data types
DateConvertibleDateOnlyDateTimeDecimalSerializedDoubleConvertible