LukeParke/plexphp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexphp.git synced 2025-12-06 04:20:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1

Browse Source
This commit is contained in:
speakeasybot
2025-04-07 00:12:46 +00:00
parent eda0eaa60d
commit 57fa772a42
96 changed files with 2100 additions and 2025 deletions
Download Patch File Download Diff File Expand all files Collapse all files

273
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -15,7 +15,7 @@ generation:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
php: php:
version: 0.14.3 version: 0.14.4
additionalDependencies: additionalDependencies:
autoload: {} autoload: {}
autoload-dev: {} autoload-dev: {}

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.528.1 speakeasyVersion: 1.529.1
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,19 +9,19 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5 sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3 sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1743725451 - speakeasy-sdk-regen-1743984680
targets: targets:
plexphp: plexphp:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:b5580df6ec4a386e12249ff13f35b916fe5559e101de4a816b53e47d6947f1a5 sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:6108b6c35fbe7e9163ffe0c804170f5e3a6edb63b8e745454ea8ee249bd790c3 sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
codeSamplesNamespace: code-samples-php-plexphp codeSamplesNamespace: code-samples-php-plexphp
codeSamplesRevisionDigest: sha256:de28f90452840202074947777b608436c2102f493423853b74d94710ee4630e3 codeSamplesRevisionDigest: sha256:5b30be3519ba86cc5dd18010a2925acfe81722ac097ca5458fcbc77c08111f11
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

130
README.md
View File

@@ -125,8 +125,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
@@ -143,126 +143,126 @@ if ($response->object !== null) {
### [activities](docs/sdks/activities/README.md) ### [activities](docs/sdks/activities/README.md)
* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities * [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
### [authentication](docs/sdks/authentication/README.md) ### [authentication](docs/sdks/authentication/README.md)
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information * [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details * [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
* [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data * [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
### [butler](docs/sdks/butler/README.md) ### [butler](docs/sdks/butler/README.md)
* [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks * [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
* [startAllTasks](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks * [startAllTasks](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
* [stopAllTasks](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks * [stopAllTasks](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task * [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
### [hubs](docs/sdks/hubs/README.md) ### [hubs](docs/sdks/hubs/README.md)
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs * [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs * [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
### [library](docs/sdks/library/README.md) ### [library](docs/sdks/library/README.md)
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value * [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children * [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content * [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
### [log](docs/sdks/log/README.md) ### [log](docs/sdks/log/README.md)
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message. * [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message * [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
### [media](docs/sdks/media/README.md) ### [media](docs/sdks/media/README.md)
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played * [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed * [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress * [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
* [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
* [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
### [playlists](docs/sdks/playlists/README.md) ### [playlists](docs/sdks/playlists/README.md)
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
* [clearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist * [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
* [deletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
* [getPlaylist](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
* [getPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
* [getPlaylists](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists * [getPlaylists](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
* [getPlaylist](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
* [deletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
* [updatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist * [updatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
* [getPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
* [clearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist * [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
### [plex](docs/sdks/plex/README.md) ### [plex](docs/sdks/plex/README.md)
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
* [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data * [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
* [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data * [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data * [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
* [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin * [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId * [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
* [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
### [search](docs/sdks/search/README.md) ### [search](docs/sdks/search/README.md)
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search * [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search * [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
### [server](docs/sdks/server/README.md) ### [server](docs/sdks/server/README.md)
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers * [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity * [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients * [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices * [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account * [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo * [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities * [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List * [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
### [sessions](docs/sdks/sessions/README.md) ### [sessions](docs/sdks/sessions/README.md)
* [getSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
* [getSessions](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions * [getSessions](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
* [getSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
* [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions * [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
* [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session * [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
### [statistics](docs/sdks/statistics/README.md) ### [statistics](docs/sdks/statistics/README.md)
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics * [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
### [updater](docs/sdks/updater/README.md) ### [updater](docs/sdks/updater/README.md)
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates * [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
### [users](docs/sdks/users/README.md) ### [users](docs/sdks/users/README.md)
@@ -294,13 +294,13 @@ By default an API error will raise a `Errors\SDKException` exception, which has
| `$rawResponse` | *?\Psr\Http\Message\ResponseInterface* | The raw HTTP response | | `$rawResponse` | *?\Psr\Http\Message\ResponseInterface* | The raw HTTP response |
| `$body` | *string* | The response content | | `$body` | *string* | The response content |
When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getMediaProviders` method throws the following exceptions: When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `getServerCapabilities` method throws the following exceptions:
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ------------------------------------ | ----------- | ---------------- | | ---------------------------------------- | ----------- | ---------------- |
| Errors\GetMediaProvidersBadRequest | 400 | application/json | | Errors\GetServerCapabilitiesBadRequest | 400 | application/json |
| Errors\GetMediaProvidersUnauthorized | 401 | application/json | | Errors\GetServerCapabilitiesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
### Example ### Example
@@ -319,17 +319,17 @@ $sdk = Plex_API\PlexAPI::builder()
->build(); ->build();
try { try {
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
// handle response // handle response
} }
} catch (Errors\GetMediaProvidersBadRequestThrowable $e) { } catch (Errors\GetServerCapabilitiesBadRequestThrowable $e) {
// handle $e->$container data // handle $e->$container data
throw $e; throw $e;
} catch (Errors\GetMediaProvidersUnauthorizedThrowable $e) { } catch (Errors\GetServerCapabilitiesUnauthorizedThrowable $e) {
// handle $e->$container data // handle $e->$container data
throw $e; throw $e;
} catch (Errors\SDKException $e) { } catch (Errors\SDKException $e) {
@@ -363,8 +363,8 @@ use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder() $sdk = Plex_API\PlexAPI::builder()
->setProtocol('https') ->setProtocol('https')
->setIp('247.38.141.142') ->setIp('e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9')
->setPort('6717') ->setPort('40311')
->setSecurity( ->setSecurity(
'<YOUR_API_KEY_HERE>' '<YOUR_API_KEY_HERE>'
) )
@@ -372,8 +372,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
@@ -400,8 +400,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
@@ -418,7 +418,6 @@ declare(strict_types=1);
require 'vendor/autoload.php'; require 'vendor/autoload.php';
use LukeHagar\Plex_API; use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder() $sdk = Plex_API\PlexAPI::builder()
->setSecurity( ->setSecurity(
@@ -428,16 +427,11 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->plex->getServerResources( $response = $sdk->plex->getCompanionsData(
'https://plex.tv/api/v2', 'https://plex.tv/api/v2'
clientID: '3381b62b-9ab7-4e37-827b-203e9809eb58',
includeHttps: Operations\IncludeHttps::Enable,
includeRelay: Operations\IncludeRelay::Enable,
includeIPv6: Operations\IncludeIPv6::Enable
); );
if ($response->plexDevices !== null) { if ($response->responseBodies !== null) {
// handle response // handle response
} }
``` ```

12
RELEASES.md
View File

@@ -832,4 +832,14 @@ Based on:
### Generated ### Generated
- [php v0.14.3] . - [php v0.14.3] .
### Releases ### Releases
- [Composer v0.14.3] https://packagist.org/packages/lukehagar/plex-api#v0.14.3 - . - [Composer v0.14.3] https://packagist.org/packages/lukehagar/plex-api#v0.14.3 - .
## 2025-04-07 00:11:04
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.14.4] .
### Releases
- [Composer v0.14.4] https://packagist.org/packages/lukehagar/plex-api#v0.14.4 - .

4
USAGE.md
View File

@@ -14,8 +14,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {

2
docs/Models/Operations/Feature.md
View File

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `type` | *string* | :heavy_check_mark: | N/A | |
| `key` | *?string* | :heavy_minus_sign: | N/A | | | `key` | *?string* | :heavy_minus_sign: | N/A | |
| `type` | *string* | :heavy_check_mark: | N/A | |
| `flavor` | *?string* | :heavy_minus_sign: | N/A | global | | `flavor` | *?string* | :heavy_minus_sign: | N/A | global |
| `scrobbleKey` | *?string* | :heavy_minus_sign: | N/A | /:/scrobble/new | | `scrobbleKey` | *?string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
| `unscrobbleKey` | *?string* | :heavy_minus_sign: | N/A | /:/unscrobble/new | | `unscrobbleKey` | *?string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |

6
docs/Models/Operations/Friend.md
View File

@@ -6,14 +6,14 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com | | `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `friendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
| `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | | | `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | | | `id` | *int* | :heavy_check_mark: | The Plex account ID | |
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `sharedServers` | array<[Operations\SharedServers](../../Models/Operations/SharedServers.md)> | :heavy_check_mark: | N/A | | | `sharedServers` | array<[Operations\SharedServers](../../Models/Operations/SharedServers.md)> | :heavy_check_mark: | N/A | |
| `sharedSources` | array<[Operations\SharedSources](../../Models/Operations/SharedSources.md)> | :heavy_check_mark: | N/A | | | `sharedSources` | array<[Operations\SharedSources](../../Models/Operations/SharedSources.md)> | :heavy_check_mark: | N/A | |
| `status` | [Operations\Status](../../Models/Operations/Status.md) | :heavy_check_mark: | Current friend request status | accepted | | `status` | [Operations\Status](../../Models/Operations/Status.md) | :heavy_check_mark: | Current friend request status | accepted |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 | | `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 | | `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
| `username` | *string* | :heavy_check_mark: | The account username | username123 | | `username` | *string* | :heavy_check_mark: | The account username | username123 |
| `uuid` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b | | `uuid` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
| `friendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |

8
docs/Models/Operations/GeoData.md
View File

@@ -11,10 +11,10 @@ Geo location data
| `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA | | `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 | | `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true | | `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true | | `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

36
docs/Models/Operations/GetAllLibrariesDirectory.md
View File

@@ -5,24 +5,24 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | true | | `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 | | `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
| `filters` | *bool* | :heavy_check_mark: | N/A | true | | `filters` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `refreshing` | *bool* | :heavy_check_mark: | N/A | false | | `refreshing` | *bool* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `key` | *string* | :heavy_check_mark: | N/A | 1 | | `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
| `type` | *string* | :heavy_check_mark: | N/A | movie | | `type` | [Operations\GetAllLibrariesType](../../Models/Operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Movies | | `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie | | `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie | | `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
| `language` | *string* | :heavy_check_mark: | N/A | en-US | | `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
| `updatedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `createdAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `createdAt` | *?int* | :heavy_minus_sign: | N/A | 1556281940 |
| `scannedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `scannedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *bool* | :heavy_check_mark: | N/A | true | | `content` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `directory` | *bool* | :heavy_check_mark: | N/A | true | | `directory` | *bool* | :heavy_check_mark: | UNKNOWN | true |
| `contentChangedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `contentChangedAt` | *int* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 | | `hidden` | [?Operations\Hidden](../../Models/Operations/Hidden.md) | :heavy_minus_sign: | N/A | 1 |
| `location` | array<[Operations\GetAllLibrariesLocation](../../Models/Operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | | | `location` | array<[Operations\GetAllLibrariesLocation](../../Models/Operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |

8
docs/Models/Operations/GetAllLibrariesLocation.md
View File

@@ -3,7 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 1 | | `id` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
| `path` | *string* | :heavy_check_mark: | N/A | /movies | | `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |

8
docs/Models/Operations/GetAllLibrariesMediaContainer.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | N/A | 5 | | `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | false | | `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library | | `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `directory` | array<[Operations\GetAllLibrariesDirectory](../../Models/Operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | | | `directory` | array<[Operations\GetAllLibrariesDirectory](../../Models/Operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |

6
docs/Models/Operations/GetAllLibrariesResponseBody.md
View File

@@ -5,6 +5,6 @@ The libraries available on the Server
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [Operations\GetAllLibrariesMediaContainer](../../Models/Operations/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A | | `mediaContainer` | [?Operations\GetAllLibrariesMediaContainer](../../Models/Operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |

15
docs/Models/Operations/GetAllLibrariesType.md Normal file
View File

@@ -0,0 +1,15 @@
# GetAllLibrariesType
The library type
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

2
docs/Models/Operations/GetAllMediaLibraryMediaContainer.md
View File

@@ -14,6 +14,7 @@
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library | | `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `librarySectionID` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 | | `librarySectionID` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series | | `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ | | `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 | | `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png | | `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
@@ -21,6 +22,5 @@
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series | | `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor | | `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary | | `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `meta` | [?Operations\GetAllMediaLibraryMeta](../../Models/Operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | | | `meta` | [?Operations\GetAllMediaLibraryMeta](../../Models/Operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `metadata` | array<[Operations\GetAllMediaLibraryMetadata](../../Models/Operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | | | `metadata` | array<[Operations\GetAllMediaLibraryMetadata](../../Models/Operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

10
docs/Models/Operations/GetAllMediaLibraryMetadata.md
View File

@@ -12,27 +12,27 @@ Unknown
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 | | `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas | | `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `type` | [Operations\GetAllMediaLibraryLibraryType](../../Models/Operations/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie | | `type` | [Operations\GetAllMediaLibraryLibraryType](../../Models/Operations/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water | | `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale | | `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `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/> | | `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/> |
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 | | `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 | | `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. | | `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 | | `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 | | `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 | | `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 | | `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 | | `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 | | `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 | | `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 | | `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright | | `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | The source from which chapter data is derived. | media | | `chapterSource` | *?string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |

8
docs/Models/Operations/GetAllMediaLibraryPart.md
View File

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true | | `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true | | `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd | | `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 | | `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 | | `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv | | `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 | | `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |

6
docs/Models/Operations/GetAllMediaLibrarySort.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc | | `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false | | `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetAllMediaLibraryActiveDirection](../../Models/Operations/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `activeDirection` | [?Operations\GetAllMediaLibraryActiveDirection](../../Models/Operations/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `defaultDirection` | [?Operations\GetAllMediaLibraryDefaultDirection](../../Models/Operations/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `defaultDirection` | [?Operations\GetAllMediaLibraryDefaultDirection](../../Models/Operations/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc | | `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |

6
docs/Models/Operations/GetAllMediaLibraryStream.md
View File

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 | | `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en | | `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
@@ -45,6 +43,8 @@
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive | | `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 | | `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true | | `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |

2
docs/Models/Operations/GetAllMediaLibraryType.md
View File

@@ -7,9 +7,9 @@
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *string* | :heavy_check_mark: | N/A | filter | | `type` | *string* | :heavy_check_mark: | N/A | filter |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows | | `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `filter` | array<[Operations\GetAllMediaLibraryFilter](../../Models/Operations/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | array<[Operations\GetAllMediaLibraryFilter](../../Models/Operations/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetAllMediaLibrarySort](../../Models/Operations/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | | | `sort` | array<[Operations\GetAllMediaLibrarySort](../../Models/Operations/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetAllMediaLibraryField](../../Models/Operations/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | | | `field` | array<[Operations\GetAllMediaLibraryField](../../Models/Operations/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | |

4
docs/Models/Operations/GetBannerImageResponse.md
View File

@@ -8,5 +8,5 @@
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `headers` | array<string, array<*string*>> | :heavy_check_mark: | N/A | | `bytes` | *?string* | :heavy_minus_sign: | Successful response returning an image |
| `bytes` | *?string* | :heavy_minus_sign: | Successful response returning an image | | `headers` | array<string, array<*string*>> | :heavy_check_mark: | N/A |

8
docs/Models/Operations/GetGeoDataGeoData.md
View File

@@ -11,10 +11,10 @@ Geo location data
| `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA | | `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 | | `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true | | `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true | | `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

4
docs/Models/Operations/GetLibraryDetailsRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `includeDetails` | [?Operations\IncludeDetails](../../Models/Operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `includeDetails` | [?Operations\IncludeDetails](../../Models/Operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | | | `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

6
docs/Models/Operations/GetLibraryItemsLibrarySort.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc | | `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false | | `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetLibraryItemsLibraryActiveDirection](../../Models/Operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `activeDirection` | [?Operations\GetLibraryItemsLibraryActiveDirection](../../Models/Operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `defaultDirection` | [?Operations\GetLibraryItemsLibraryDefaultDirection](../../Models/Operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `defaultDirection` | [?Operations\GetLibraryItemsLibraryDefaultDirection](../../Models/Operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc | | `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |

6
docs/Models/Operations/GetLibraryItemsMedia.md
View File

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `part` | array<[Operations\GetLibraryItemsPart](../../Models/Operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *?int* | :heavy_minus_sign: | N/A | 3840 | | `width` | *?int* | :heavy_minus_sign: | N/A | 3840 |
@@ -18,8 +16,10 @@
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 | | `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc | | `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k | | `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p | | `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 | | `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false | | `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [?Operations\GetLibraryItemsOptimizedForStreaming](../../Models/Operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 | | `optimizedForStreaming` | [?Operations\GetLibraryItemsOptimizedForStreaming](../../Models/Operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `part` | array<[Operations\GetLibraryItemsPart](../../Models/Operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |

6
docs/Models/Operations/GetLibraryItemsMediaContainer.md
View File

@@ -8,11 +8,14 @@ The Meta object is only included in the response if the `includeMeta` parameter
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `type` | array<[Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
| `size` | *int* | :heavy_check_mark: | N/A | 70 | | `size` | *int* | :heavy_check_mark: | N/A | 70 |
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 | | `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
| `offset` | *int* | :heavy_check_mark: | N/A | 0 | | `offset` | *int* | :heavy_check_mark: | N/A | 0 |
| `content` | *string* | :heavy_check_mark: | N/A | secondary | | `content` | *string* | :heavy_check_mark: | N/A | secondary |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | true | | `allowSync` | *bool* | :heavy_check_mark: | N/A | true |
| `nocache` | *?bool* | :heavy_minus_sign: | N/A | true |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library | | `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | *int* | :heavy_check_mark: | N/A | 1 | | `librarySectionID` | *int* | :heavy_check_mark: | N/A | 1 |
@@ -24,9 +27,6 @@ The Meta object is only included in the response if the `includeMeta` parameter
| `title1` | *string* | :heavy_check_mark: | N/A | Movies | | `title1` | *string* | :heavy_check_mark: | N/A | Movies |
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released | | `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie | | `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
| `type` | array<[Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
| `nocache` | *?bool* | :heavy_minus_sign: | N/A | true |
| `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 | | `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | true | | `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | true |
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | | | `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |

8
docs/Models/Operations/GetLibraryItemsMetadata.md
View File

@@ -8,17 +8,16 @@
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 | | `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 | | `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [Operations\GetLibraryItemsLibraryType](../../Models/Operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios | | `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false | | `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 | | `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies | | `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 | | `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [Operations\GetLibraryItemsLibraryType](../../Models/Operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas | | `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 | | `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 | | `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 | | `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 | | `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
@@ -33,6 +32,7 @@
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC | | `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media | | `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |

2
docs/Models/Operations/GetLibraryItemsPart.md
View File

@@ -7,10 +7,10 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts | | `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false | | `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |

2
docs/Models/Operations/GetLibraryItemsRequest.md
View File

@@ -6,9 +6,9 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tag` | [Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | | | `tag` | [Operations\Tag](../../Models/Operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `includeGuids` | [?Operations\IncludeGuids](../../Models/Operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [Operations\GetLibraryItemsQueryParamType](../../Models/Operations/GetLibraryItemsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 | | `type` | [Operations\GetLibraryItemsQueryParamType](../../Models/Operations/GetLibraryItemsQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `includeGuids` | [?Operations\IncludeGuids](../../Models/Operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `includeMeta` | [?Operations\GetLibraryItemsQueryParamIncludeMeta](../../Models/Operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [?Operations\GetLibraryItemsQueryParamIncludeMeta](../../Models/Operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | | `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

6
docs/Models/Operations/GetLibraryItemsSort.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc | | `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false | | `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetLibraryItemsActiveDirection](../../Models/Operations/GetLibraryItemsActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `activeDirection` | [?Operations\GetLibraryItemsActiveDirection](../../Models/Operations/GetLibraryItemsActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `defaultDirection` | [?Operations\GetLibraryItemsDefaultDirection](../../Models/Operations/GetLibraryItemsDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `defaultDirection` | [?Operations\GetLibraryItemsDefaultDirection](../../Models/Operations/GetLibraryItemsDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc | | `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |

4
docs/Models/Operations/GetLibraryItemsStream.md
View File

@@ -7,10 +7,10 @@
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 | | `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 | | `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true | | `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true | | `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 | | `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 | | `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv | | `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |

2
docs/Models/Operations/GetLibraryItemsType.md
View File

@@ -7,9 +7,9 @@
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *string* | :heavy_check_mark: | N/A | filter | | `type` | *string* | :heavy_check_mark: | N/A | filter |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows | | `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `filter` | array<[Operations\GetLibraryItemsFilter](../../Models/Operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | array<[Operations\GetLibraryItemsFilter](../../Models/Operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetLibraryItemsSort](../../Models/Operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | | | `sort` | array<[Operations\GetLibraryItemsSort](../../Models/Operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetLibraryItemsField](../../Models/Operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | | | `field` | array<[Operations\GetLibraryItemsField](../../Models/Operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |

4
docs/Models/Operations/GetMediaArtsMetadata.md
View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg | | `key` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `provider` | *?string* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
| `ratingKey` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg | | `ratingKey` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `selected` | *bool* | :heavy_check_mark: | Whether this is the selected artwork. | true | | `selected` | *bool* | :heavy_check_mark: | Whether this is the selected artwork. | true |
| `thumb` | *string* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg | | `thumb` | *string* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |
| `provider` | *?string* | :heavy_minus_sign: | The provider of the artwork. | tmdb |

4
docs/Models/Operations/GetMediaMetaDataMediaContainer.md
View File

@@ -10,7 +10,7 @@
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library | | `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `librarySectionID` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 | | `librarySectionID` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series | | `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ | | `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 | | `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `metadata` | array<[Operations\GetMediaMetaDataMetadata](../../Models/Operations/GetMediaMetaDataMetadata.md)> | :heavy_check_mark: | An array of metadata items. | | | `metadata` | array<[Operations\GetMediaMetaDataMetadata](../../Models/Operations/GetMediaMetaDataMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |

32
docs/Models/Operations/GetMediaMetaDataMetadata.md
View File

@@ -6,22 +6,6 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 | | `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
| `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionID` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updatedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
| `ultraBlurColors` | [Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 | | `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 | | `grandparentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
| `parentGuid` | *?string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c | | `parentGuid` | *?string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
@@ -29,10 +13,18 @@
| `grandparentSlug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 | | `grandparentSlug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
| `grandparentKey` | *?string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 | | `grandparentKey` | *?string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
| `parentKey` | *?string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 | | `parentKey` | *?string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
| `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
| `slug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul | | `slug` | *?string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television | | `studio` | *?string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
| `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
| `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I | | `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `librarySectionID` | *int* | :heavy_check_mark: | The ID of the library section. | 2 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `contentRating` | *?string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA | | `contentRating` | *?string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
| `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `index` | *?int* | :heavy_minus_sign: | The index or order of the item. | 1 | | `index` | *?int* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland | | `grandparentTitle` | *?string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `parentTitle` | *?string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 | | `parentTitle` | *?string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
@@ -40,22 +32,30 @@
| `viewCount` | *?int* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 | | `viewCount` | *?int* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `skipCount` | *?int* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 | | `skipCount` | *?int* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 | | `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `rating` | *?float* | :heavy_minus_sign: | The general rating | 6 | | `rating` | *?float* | :heavy_minus_sign: | The general rating | 6 |
| `ratingImage` | *?string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe | | `ratingImage` | *?string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `tagline` | *?string* | :heavy_minus_sign: | The tagline of the content. | Make the call | | `tagline` | *?string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media | | `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/134704 | | `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `theme` | *?string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 | | `theme` | *?string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date. | 2015-02-08 | | `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `leafCount` | *?int* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 | | `leafCount` | *?int* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 | | `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `childCount` | *?int* | :heavy_minus_sign: | The number of child items. | 6 | | `childCount` | *?int* | :heavy_minus_sign: | The number of child items. | 6 |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `updatedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating | | `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
| `parentIndex` | *?int* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 | | `parentIndex` | *?int* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `parentThumb` | *?string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 | | `parentThumb` | *?string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 | | `grandparentThumb` | *?string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 | | `grandparentArt` | *?string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
| `media` | array<[Operations\GetMediaMetaDataMedia](../../Models/Operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | | | `media` | array<[Operations\GetMediaMetaDataMedia](../../Models/Operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
| `ultraBlurColors` | [Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
| `genre` | array<[Operations\GetMediaMetaDataGenre](../../Models/Operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | | | `genre` | array<[Operations\GetMediaMetaDataGenre](../../Models/Operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
| `country` | array<[Operations\GetMediaMetaDataCountry](../../Models/Operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | | | `country` | array<[Operations\GetMediaMetaDataCountry](../../Models/Operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | |
| `guids` | array<[Operations\GetMediaMetaDataGuids](../../Models/Operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | | | `guids` | array<[Operations\GetMediaMetaDataGuids](../../Models/Operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | |

8
docs/Models/Operations/GetMediaMetaDataPart.md
View File

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true | | `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true | | `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd | | `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 | | `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 | | `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv | | `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 | | `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |

6
docs/Models/Operations/GetMediaMetaDataStream.md
View File

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 | | `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en | | `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
@@ -45,6 +43,8 @@
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive | | `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 | | `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true | | `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |

4
docs/Models/Operations/GetMediaPostersMetadata.md
View File

@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg | | `key` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
| `provider` | *?string* | :heavy_minus_sign: | The provider of the poster. | tmdb |
| `ratingKey` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg | | `ratingKey` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
| `selected` | *bool* | :heavy_check_mark: | Whether this is the selected poster. | true | | `selected` | *bool* | :heavy_check_mark: | Whether this is the selected poster. | true |
| `thumb` | *string* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg | | `thumb` | *string* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |
| `provider` | *?string* | :heavy_minus_sign: | The provider of the poster. | tmdb |

4
docs/Models/Operations/GetPinAuthPinContainer.md
View File

@@ -10,12 +10,12 @@ Requests a new pin id used in the authentication flow
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 | | `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *string* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *string* | :heavy_check_mark: | N/A | Tautulli | | `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 | | `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 | | `clientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [Operations\GeoData](../../Models/Operations/GeoData.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [Operations\GeoData](../../Models/Operations/GeoData.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expiresIn` | *?int* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expiresAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expiresAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *?bool* | :heavy_minus_sign: | N/A | |
| `expiresIn` | *?int* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `authToken` | *?string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 | | `authToken` | *?string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `newRegistration` | *mixed* | :heavy_minus_sign: | N/A | | | `newRegistration` | *mixed* | :heavy_minus_sign: | N/A | |

2
docs/Models/Operations/GetPinRequest.md
View File

@@ -5,8 +5,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `strong` | *?bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | | | `strong` | *?bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *?string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | | `clientName` | *?string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *?string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `deviceNickname` | *?string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `clientVersion` | *?string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 | | `clientVersion` | *?string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |

2
docs/Models/Operations/GetRecentlyAddedLibraryRequest.md
View File

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\QueryParamType](../../Models/Operations/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `contentDirectoryID` | *?int* | :heavy_minus_sign: | N/A | 2 | | `contentDirectoryID` | *?int* | :heavy_minus_sign: | N/A | 2 |
| `pinnedContentDirectoryID` | array<*int*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] | | `pinnedContentDirectoryID` | array<*int*> | :heavy_minus_sign: | N/A | [<br/>3,<br/>5,<br/>7,<br/>13,<br/>12,<br/>1,<br/>6,<br/>14,<br/>2,<br/>10,<br/>16,<br/>17<br/>] |
| `sectionID` | *?int* | :heavy_minus_sign: | The library section ID for filtering content. | 2 | | `sectionID` | *?int* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [Operations\QueryParamType](../../Models/Operations/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeMeta` | [?Operations\QueryParamIncludeMeta](../../Models/Operations/QueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [?Operations\QueryParamIncludeMeta](../../Models/Operations/QueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | | `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

2
docs/Models/Operations/GetRecentlyAddedLibraryType.md
View File

@@ -7,9 +7,9 @@
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *string* | :heavy_check_mark: | N/A | filter | | `type` | *string* | :heavy_check_mark: | N/A | filter |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows | | `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `filter` | array<[Operations\GetRecentlyAddedLibraryFilter](../../Models/Operations/GetRecentlyAddedLibraryFilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | array<[Operations\GetRecentlyAddedLibraryFilter](../../Models/Operations/GetRecentlyAddedLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\Sort](../../Models/Operations/Sort.md)> | :heavy_minus_sign: | N/A | | | `sort` | array<[Operations\Sort](../../Models/Operations/Sort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\Field](../../Models/Operations/Field.md)> | :heavy_minus_sign: | N/A | | | `field` | array<[Operations\Field](../../Models/Operations/Field.md)> | :heavy_minus_sign: | N/A | |

46
docs/Models/Operations/GetRecentlyAddedMetadata.md
View File

@@ -10,34 +10,14 @@ Unknown
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 | | `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `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 |
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `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 |
| `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 |
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `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` | [Operations\GetRecentlyAddedHubsType](../../Models/Operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright | | `audienceRatingImage` | *?string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `audienceRating` | *float* | :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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `grandparentKey` | *?string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
@@ -46,23 +26,43 @@ Unknown
| `grandparentTheme` | *?string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 | | `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 | | `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 | | `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` | *?int* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 | | `lastRatedAt` | *?int* | :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 | | `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 | | `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 | | `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | 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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `skipCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `studio` | *?string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios | | `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 | | `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` | [Operations\GetRecentlyAddedHubsType](../../Models/Operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | N/A | movie |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *?int* | :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 | | `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 | | `viewCount` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |

2
docs/Models/Operations/GetRecentlyAddedRequest.md
View File

@@ -6,9 +6,9 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentDirectoryID` | *int* | :heavy_check_mark: | The content directory ID. | | | `contentDirectoryID` | *int* | :heavy_check_mark: | The content directory ID. | |
| `type` | [Operations\Type](../../Models/Operations/Type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `pinnedContentDirectoryID` | *?string* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | | | `pinnedContentDirectoryID` | *?string* | :heavy_minus_sign: | Comma-separated list of pinned content directory IDs. | |
| `sectionID` | *?int* | :heavy_minus_sign: | The library section ID for filtering content. | 2 | | `sectionID` | *?int* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
| `type` | [Operations\Type](../../Models/Operations/Type.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `includeMeta` | [?Operations\IncludeMeta](../../Models/Operations/IncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [?Operations\IncludeMeta](../../Models/Operations/IncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | | `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

6
docs/Models/Operations/GetRecentlyAddedSort.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc | | `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false | | `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetRecentlyAddedActiveDirection](../../Models/Operations/GetRecentlyAddedActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `activeDirection` | [?Operations\GetRecentlyAddedActiveDirection](../../Models/Operations/GetRecentlyAddedActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `defaultDirection` | [?Operations\GetRecentlyAddedDefaultDirection](../../Models/Operations/GetRecentlyAddedDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `defaultDirection` | [?Operations\GetRecentlyAddedDefaultDirection](../../Models/Operations/GetRecentlyAddedDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc | | `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |

2
docs/Models/Operations/GetRecentlyAddedType.md
View File

@@ -7,9 +7,9 @@
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 | | `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *string* | :heavy_check_mark: | N/A | filter | | `type` | *string* | :heavy_check_mark: | N/A | filter |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows | | `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false | | `active` | *bool* | :heavy_check_mark: | N/A | false |
| `subtype` | *?string* | :heavy_minus_sign: | N/A | clip |
| `filter` | array<[Operations\GetRecentlyAddedFilter](../../Models/Operations/GetRecentlyAddedFilter.md)> | :heavy_minus_sign: | N/A | | | `filter` | array<[Operations\GetRecentlyAddedFilter](../../Models/Operations/GetRecentlyAddedFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetRecentlyAddedSort](../../Models/Operations/GetRecentlyAddedSort.md)> | :heavy_minus_sign: | N/A | | | `sort` | array<[Operations\GetRecentlyAddedSort](../../Models/Operations/GetRecentlyAddedSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetRecentlyAddedField](../../Models/Operations/GetRecentlyAddedField.md)> | :heavy_minus_sign: | N/A | | | `field` | array<[Operations\GetRecentlyAddedField](../../Models/Operations/GetRecentlyAddedField.md)> | :heavy_minus_sign: | N/A | |

4
docs/Models/Operations/GetRefreshLibraryMetadataRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `force` | [?Operations\Force](../../Models/Operations/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `force` | [?Operations\Force](../../Models/Operations/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 | | `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |

6
docs/Models/Operations/GetSearchAllLibrariesMedia.md
View File

@@ -6,8 +6,6 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 | | `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `part` | array<[Operations\GetSearchAllLibrariesPart](../../Models/Operations/GetSearchAllLibrariesPart.md)> | :heavy_check_mark: | N/A | |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 | | `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 |
| `width` | *?int* | :heavy_minus_sign: | N/A | 3840 | | `width` | *?int* | :heavy_minus_sign: | N/A | 3840 |
@@ -18,8 +16,10 @@
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 | | `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc | | `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc |
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k | | `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p | | `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 | | `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false | | `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [?Operations\GetSearchAllLibrariesOptimizedForStreaming](../../Models/Operations/GetSearchAllLibrariesOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 | | `optimizedForStreaming` | [?Operations\GetSearchAllLibrariesOptimizedForStreaming](../../Models/Operations/GetSearchAllLibrariesOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `part` | array<[Operations\GetSearchAllLibrariesPart](../../Models/Operations/GetSearchAllLibrariesPart.md)> | :heavy_check_mark: | N/A | |

8
docs/Models/Operations/GetSearchAllLibrariesMetadata.md
View File

@@ -8,17 +8,16 @@
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 | | `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 | | `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 | | `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [Operations\GetSearchAllLibrariesType](../../Models/Operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios | | `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false | | `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 | | `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies | | `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 | | `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `type` | [Operations\GetSearchAllLibrariesType](../../Models/Operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas | | `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 | | `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 | | `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 | | `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 | | `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
@@ -33,6 +32,7 @@
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 | | `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 | | `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC | | `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright | | `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media | | `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |

2
docs/Models/Operations/GetSearchAllLibrariesPart.md
View File

@@ -7,10 +7,10 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 | | `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv | | `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv | | `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 | | `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv | | `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts | | `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false | | `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |

4
docs/Models/Operations/GetSearchAllLibrariesStream.md
View File

@@ -7,10 +7,10 @@
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 | | `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 | | `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true | | `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true | | `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 | | `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 | | `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv | | `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |

4
docs/Models/Operations/GetServerResourcesRequest.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | | `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | | `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |

4
docs/Models/Operations/GetThumbImageResponse.md
View File

@@ -8,5 +8,5 @@
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `headers` | array<string, array<*string*>> | :heavy_check_mark: | N/A | | `bytes` | *?string* | :heavy_minus_sign: | Successful response returning an image |
| `bytes` | *?string* | :heavy_minus_sign: | Successful response returning an image | | `headers` | array<string, array<*string*>> | :heavy_check_mark: | N/A |

4
docs/Models/Operations/GetTokenByPinIdAuthPinContainer.md
View File

@@ -10,12 +10,12 @@ The Pin with a non-null authToken when it has been verified by the user
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 | | `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *string* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *string* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *string* | :heavy_check_mark: | N/A | Tautulli | | `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 | | `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 | | `clientIdentifier` | *string* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [Operations\GetTokenByPinIdGeoData](../../Models/Operations/GetTokenByPinIdGeoData.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [Operations\GetTokenByPinIdGeoData](../../Models/Operations/GetTokenByPinIdGeoData.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expiresIn` | *?int* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expiresAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expiresAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *?bool* | :heavy_minus_sign: | N/A | |
| `expiresIn` | *?int* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `authToken` | *?string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 | | `authToken` | *?string* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `newRegistration` | *mixed* | :heavy_minus_sign: | N/A | | | `newRegistration` | *mixed* | :heavy_minus_sign: | N/A | |

8
docs/Models/Operations/GetTokenByPinIdGeoData.md
View File

@@ -11,10 +11,10 @@ Geo location data
| `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA | | `continentCode` | *string* | :heavy_check_mark: | The continent code where the country is located. | NA |
| `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *string* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *string* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `timeZone` | *string* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 | | `postalCode` | *string* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `europeanUnionMember` | *?bool* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |
| `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true | | `inPrivacyRestrictedCountry` | *?bool* | :heavy_minus_sign: | Indicates if the country has privacy restrictions. | true |
| `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true | | `inPrivacyRestrictedRegion` | *?bool* | :heavy_minus_sign: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *string* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *string* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |

2
docs/Models/Operations/GetTokenDetailsSubscription.md
View File

@@ -7,7 +7,7 @@
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `status` | [?Operations\GetTokenDetailsAuthenticationResponseStatus](../../Models/Operations/GetTokenDetailsAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [?Operations\GetTokenDetailsAuthenticationResponseStatus](../../Models/Operations/GetTokenDetailsAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | | | `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | | | `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

42
docs/Models/Operations/GetTokenDetailsUserPlexAccount.md
View File

@@ -7,44 +7,44 @@ Logged in user details
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `country` | *string* | :heavy_check_mark: | The account country | US |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | array<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `mailingListStatus` | [Operations\MailingListStatus](../../Models/Operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [Operations\UserProfile](../../Models/Operations/UserProfile.md) | :heavy_check_mark: | N/A | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\Services](../../Models/Operations/Services.md)> | :heavy_check_mark: | N/A | |
| `subscription` | [Operations\Subscription](../../Models/Operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *string* | :heavy_check_mark: | The account username | Username |
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `adsConsent` | *bool* | :heavy_check_mark: | Unknown | | | `adsConsent` | *bool* | :heavy_check_mark: | Unknown | |
| `adsConsentReminderAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `adsConsentReminderAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `adsConsentSetAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `adsConsentSetAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `anonymous` | *?bool* | :heavy_minus_sign: | Unknown | |
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `backupCodesCreated` | *?bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | | | `backupCodesCreated` | *?bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
| `confirmed` | *?bool* | :heavy_minus_sign: | If the account has been confirmed | | | `confirmed` | *?bool* | :heavy_minus_sign: | If the account has been confirmed | |
| `country` | *string* | :heavy_check_mark: | The account country | US |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `emailOnlyAuth` | *?bool* | :heavy_minus_sign: | If login with email only is enabled | | | `emailOnlyAuth` | *?bool* | :heavy_minus_sign: | If login with email only is enabled | |
| `experimentalFeatures` | *?bool* | :heavy_minus_sign: | If experimental features are enabled | | | `experimentalFeatures` | *?bool* | :heavy_minus_sign: | If experimental features are enabled | |
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | array<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `guest` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home guest user | | | `guest` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
| `hasPassword` | *?bool* | :heavy_minus_sign: | If the account has a password | | | `hasPassword` | *?bool* | :heavy_minus_sign: | If the account has a password | |
| `home` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home user | | | `home` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home user | |
| `homeAdmin` | *?bool* | :heavy_minus_sign: | If the account is the Plex Home admin | | | `homeAdmin` | *?bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *string* | :heavy_check_mark: | The account locale | | | `locale` | *string* | :heavy_check_mark: | The account locale | |
| `mailingListActive` | *?bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | | | `mailingListActive` | *?bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [Operations\MailingListStatus](../../Models/Operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *?string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | | | ~~`pin`~~ | *?string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [Operations\UserProfile](../../Models/Operations/UserProfile.md) | :heavy_check_mark: | N/A | |
| `protected` | *?bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | | | `protected` | *?bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | | | `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | array<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | | | `roles` | array<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\Services](../../Models/Operations/Services.md)> | :heavy_check_mark: | N/A | |
| `subscription` | [Operations\Subscription](../../Models/Operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | | | `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | array<[Operations\GetTokenDetailsSubscription](../../Models/Operations/GetTokenDetailsSubscription.md)> | :heavy_minus_sign: | N/A | | | `subscriptions` | array<[Operations\GetTokenDetailsSubscription](../../Models/Operations/GetTokenDetailsSubscription.md)> | :heavy_minus_sign: | N/A | |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `twoFactorEnabled` | *?bool* | :heavy_minus_sign: | If two-factor authentication is enabled | | | `twoFactorEnabled` | *?bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> | | `username` | *string* | :heavy_check_mark: | The account username | Username |
| `anonymous` | *?bool* | :heavy_minus_sign: | Unknown | | | `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> |

4
docs/Models/Operations/GetTopWatchedContentRequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\GetTopWatchedContentQueryParamType](../../Models/Operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 | | `includeGuids` | *?int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `includeGuids` | *?int* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 | | `type` | [Operations\GetTopWatchedContentQueryParamType](../../Models/Operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

4
docs/Models/Operations/GetUsersRequest.md
View File

@@ -6,7 +6,6 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 | | `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `clientName` | *?string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku | | `clientName` | *?string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *?string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 | | `deviceNickname` | *?string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `deviceName` | *?string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome | | `deviceName` | *?string* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
@@ -17,4 +16,5 @@
| `model` | *?string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X | | `model` | *?string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexSessionId` | *?string* | :heavy_minus_sign: | The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca) | 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca | | `xPlexSessionId` | *?string* | :heavy_minus_sign: | The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca) | 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca |
| `xPlexLanguage` | *?string* | :heavy_minus_sign: | The language of the client application. | en | | `xPlexLanguage` | *?string* | :heavy_minus_sign: | The language of the client application. | en |
| `platformVersion` | *?string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 | | `platformVersion` | *?string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

4
docs/Models/Operations/GetWatchListRequest.md
View File

@@ -6,11 +6,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | [Operations\Filter](../../Models/Operations/Filter.md) | :heavy_check_mark: | Filter | | | `filter` | [Operations\Filter](../../Models/Operations/Filter.md) | :heavy_check_mark: | Filter | |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
| `sort` | *?string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | | | `sort` | *?string* | :heavy_minus_sign: | In the format "field:dir". Available fields are "watchlistedAt" (Added At),<br/>"titleSort" (Title), "originallyAvailableAt" (Release Date), or "rating" (Critic Rating).<br/>"dir" can be "asc" or "desc"<br/> | |
| `libtype` | [?Operations\Libtype](../../Models/Operations/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | | | `libtype` | [?Operations\Libtype](../../Models/Operations/Libtype.md) | :heavy_minus_sign: | The type of library to filter. Can be "movie" or "show", or all if not present.<br/> | |
| `maxresults` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | | | `maxresults` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/> | |
| `includeCollections` | [?Operations\IncludeCollections](../../Models/Operations/IncludeCollections.md) | :heavy_minus_sign: | include collections in the results<br/> | | | `includeCollections` | [?Operations\IncludeCollections](../../Models/Operations/IncludeCollections.md) | :heavy_minus_sign: | include collections in the results<br/> | |
| `includeExternalMedia` | [?Operations\IncludeExternalMedia](../../Models/Operations/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> | | | `includeExternalMedia` | [?Operations\IncludeExternalMedia](../../Models/Operations/IncludeExternalMedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `xPlexContainerStart` | *?int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | | `xPlexContainerSize` | *?int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

11
docs/Models/Operations/Hidden.md Normal file
View File

@@ -0,0 +1,11 @@
# Hidden
UNKNOWN
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

8
docs/Models/Operations/Part.md
View File

@@ -5,14 +5,14 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true | | `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true | | `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd | | `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 | | `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `size` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 | | `packetLength` | *?int* | :heavy_minus_sign: | N/A | 188 |
| `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv | | `container` | *?string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 | | `videoProfile` | *?string* | :heavy_minus_sign: | Video profile for the part. | main 10 |

8
docs/Models/Operations/PastSubscription.md
View File

@@ -5,9 +5,6 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `type` | *string* | :heavy_check_mark: | N/A | plexpass |
| `state` | [Operations\PostUsersSignInDataState](../../Models/Operations/PostUsersSignInDataState.md) | :heavy_check_mark: | N/A | ended |
| `billing` | [Operations\Billing](../../Models/Operations/Billing.md) | :heavy_check_mark: | N/A | |
| `id` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | |
| `mode` | *string* | :heavy_check_mark: | N/A | | | `mode` | *string* | :heavy_check_mark: | N/A | |
| `renewsAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `renewsAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
@@ -19,4 +16,7 @@
| `canUpgrade` | *?bool* | :heavy_minus_sign: | N/A | false | | `canUpgrade` | *?bool* | :heavy_minus_sign: | N/A | false |
| `canDowngrade` | *?bool* | :heavy_minus_sign: | N/A | false | | `canDowngrade` | *?bool* | :heavy_minus_sign: | N/A | false |
| `canConvert` | *?bool* | :heavy_minus_sign: | N/A | false | | `canConvert` | *?bool* | :heavy_minus_sign: | N/A | false |
| `transfer` | *string* | :heavy_check_mark: | N/A | | | `type` | *string* | :heavy_check_mark: | N/A | plexpass |
| `transfer` | *string* | :heavy_check_mark: | N/A | |
| `state` | [Operations\PostUsersSignInDataState](../../Models/Operations/PostUsersSignInDataState.md) | :heavy_check_mark: | N/A | ended |
| `billing` | [Operations\Billing](../../Models/Operations/Billing.md) | :heavy_check_mark: | N/A | |

12
docs/Models/Operations/PlexDevice.md
View File

@@ -8,10 +8,15 @@
| `name` | *string* | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | |
| `product` | *string* | :heavy_check_mark: | N/A | | | `product` | *string* | :heavy_check_mark: | N/A | |
| `productVersion` | *string* | :heavy_check_mark: | N/A | | | `productVersion` | *string* | :heavy_check_mark: | N/A | |
| `platform` | *string* | :heavy_check_mark: | N/A | |
| `platformVersion` | *string* | :heavy_check_mark: | N/A | |
| `device` | *string* | :heavy_check_mark: | N/A | |
| `clientIdentifier` | *string* | :heavy_check_mark: | N/A | | | `clientIdentifier` | *string* | :heavy_check_mark: | N/A | |
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z | | `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `lastSeenAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z | | `lastSeenAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `provides` | *string* | :heavy_check_mark: | N/A | | | `provides` | *string* | :heavy_check_mark: | N/A | |
| `ownerId` | *int* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
| `sourceTitle` | *string* | :heavy_check_mark: | N/A | |
| `publicAddress` | *string* | :heavy_check_mark: | N/A | | | `publicAddress` | *string* | :heavy_check_mark: | N/A | |
| `accessToken` | *string* | :heavy_check_mark: | N/A | | | `accessToken` | *string* | :heavy_check_mark: | N/A | |
| `owned` | *bool* | :heavy_check_mark: | N/A | | | `owned` | *bool* | :heavy_check_mark: | N/A | |
@@ -23,9 +28,4 @@
| `publicAddressMatches` | *bool* | :heavy_check_mark: | N/A | | | `publicAddressMatches` | *bool* | :heavy_check_mark: | N/A | |
| `dnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A | | | `dnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A | |
| `natLoopbackSupported` | *bool* | :heavy_check_mark: | N/A | | | `natLoopbackSupported` | *bool* | :heavy_check_mark: | N/A | |
| `connections` | array<[Operations\Connections](../../Models/Operations/Connections.md)> | :heavy_check_mark: | N/A | | | `connections` | array<[Operations\Connections](../../Models/Operations/Connections.md)> | :heavy_check_mark: | N/A | |
| `platform` | *string* | :heavy_check_mark: | N/A | |
| `platformVersion` | *string* | :heavy_check_mark: | N/A | |
| `device` | *string* | :heavy_check_mark: | N/A | |
| `ownerId` | *int* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
| `sourceTitle` | *string* | :heavy_check_mark: | N/A | |

2
docs/Models/Operations/PostUsersSignInDataAuthenticationSubscription.md
View File

@@ -7,7 +7,7 @@
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `status` | [?Operations\PostUsersSignInDataAuthenticationResponseStatus](../../Models/Operations/PostUsersSignInDataAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [?Operations\PostUsersSignInDataAuthenticationResponseStatus](../../Models/Operations/PostUsersSignInDataAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | | | `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | | | `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

4
docs/Models/Operations/PostUsersSignInDataServices.md
View File

@@ -7,6 +7,6 @@
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev | | `identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
| `endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv | | `endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
| `status` | [Operations\PostUsersSignInDataStatus](../../Models/Operations/PostUsersSignInDataStatus.md) | :heavy_check_mark: | N/A | online |
| `token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv | | `token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
| `secret` | *string* | :heavy_check_mark: | N/A | | | `secret` | *string* | :heavy_check_mark: | N/A | |
| `status` | [Operations\PostUsersSignInDataStatus](../../Models/Operations/PostUsersSignInDataStatus.md) | :heavy_check_mark: | N/A | online |

2
docs/Models/Operations/PostUsersSignInDataSubscription.md
View File

@@ -9,7 +9,7 @@ If the account’s Plex Pass subscription is active
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `status` | [?Operations\PostUsersSignInDataAuthenticationStatus](../../Models/Operations/PostUsersSignInDataAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [?Operations\PostUsersSignInDataAuthenticationStatus](../../Models/Operations/PostUsersSignInDataAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | | | `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | | | `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

44
docs/Models/Operations/PostUsersSignInDataUserPlexAccount.md
View File

@@ -7,46 +7,46 @@ Returns the user account data with a valid auth token
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `country` | *string* | :heavy_check_mark: | The account country | US |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | array<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `mailingListStatus` | [Operations\PostUsersSignInDataMailingListStatus](../../Models/Operations/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [Operations\PostUsersSignInDataUserProfile](../../Models/Operations/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\PostUsersSignInDataServices](../../Models/Operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
| `subscription` | [Operations\PostUsersSignInDataSubscription](../../Models/Operations/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *string* | :heavy_check_mark: | The account username | Username |
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `pastSubscriptions` | array<[Operations\PastSubscription](../../Models/Operations/PastSubscription.md)> | :heavy_check_mark: | N/A | |
| `trials` | array<[Operations\Trials](../../Models/Operations/Trials.md)> | :heavy_check_mark: | N/A | |
| `adsConsent` | *bool* | :heavy_check_mark: | Unknown | | | `adsConsent` | *bool* | :heavy_check_mark: | Unknown | |
| `adsConsentReminderAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `adsConsentReminderAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `adsConsentSetAt` | *int* | :heavy_check_mark: | N/A | 1556281940 | | `adsConsentSetAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `anonymous` | *?bool* | :heavy_minus_sign: | Unknown | |
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `backupCodesCreated` | *?bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | | | `backupCodesCreated` | *?bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
| `confirmed` | *?bool* | :heavy_minus_sign: | If the account has been confirmed | | | `confirmed` | *?bool* | :heavy_minus_sign: | If the account has been confirmed | |
| `country` | *string* | :heavy_check_mark: | The account country | US |
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `emailOnlyAuth` | *?bool* | :heavy_minus_sign: | If login with email only is enabled | | | `emailOnlyAuth` | *?bool* | :heavy_minus_sign: | If login with email only is enabled | |
| `experimentalFeatures` | *?bool* | :heavy_minus_sign: | If experimental features are enabled | | | `experimentalFeatures` | *?bool* | :heavy_minus_sign: | If experimental features are enabled | |
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `entitlements` | array<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `guest` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home guest user | | | `guest` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
| `hasPassword` | *?bool* | :heavy_minus_sign: | If the account has a password | | | `hasPassword` | *?bool* | :heavy_minus_sign: | If the account has a password | |
| `home` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home user | | | `home` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home user | |
| `homeAdmin` | *?bool* | :heavy_minus_sign: | If the account is the Plex Home admin | | | `homeAdmin` | *?bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *string* | :heavy_check_mark: | The account locale | | | `locale` | *string* | :heavy_check_mark: | The account locale | |
| `mailingListActive` | *?bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | | | `mailingListActive` | *?bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [Operations\PostUsersSignInDataMailingListStatus](../../Models/Operations/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`pin`~~ | *?string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | | | ~~`pin`~~ | *?string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `profile` | [Operations\PostUsersSignInDataUserProfile](../../Models/Operations/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `protected` | *?bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | | | `protected` | *?bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | | | `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | array<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | | | `roles` | array<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\PostUsersSignInDataServices](../../Models/Operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
| `subscription` | [Operations\PostUsersSignInDataSubscription](../../Models/Operations/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | | | `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | array<[Operations\PostUsersSignInDataAuthenticationSubscription](../../Models/Operations/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_minus_sign: | N/A | | | `subscriptions` | array<[Operations\PostUsersSignInDataAuthenticationSubscription](../../Models/Operations/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_minus_sign: | N/A | |
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `twoFactorEnabled` | *?bool* | :heavy_minus_sign: | If two-factor authentication is enabled | | | `twoFactorEnabled` | *?bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
| `username` | *string* | :heavy_check_mark: | The account username | Username |
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
| `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> | | `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> |
| `anonymous` | *?bool* | :heavy_minus_sign: | Unknown | | | `pastSubscriptions` | array<[Operations\PastSubscription](../../Models/Operations/PastSubscription.md)> | :heavy_check_mark: | N/A | |
| `trials` | array<[Operations\Trials](../../Models/Operations/Trials.md)> | :heavy_check_mark: | N/A | |

4
docs/Models/Operations/Services.md
View File

@@ -7,6 +7,6 @@
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev | | `identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
| `endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv | | `endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
| `status` | [Operations\GetTokenDetailsStatus](../../Models/Operations/GetTokenDetailsStatus.md) | :heavy_check_mark: | N/A | online |
| `token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv | | `token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
| `secret` | *string* | :heavy_check_mark: | N/A | | | `secret` | *string* | :heavy_check_mark: | N/A | |
| `status` | [Operations\GetTokenDetailsStatus](../../Models/Operations/GetTokenDetailsStatus.md) | :heavy_check_mark: | N/A | online |

6
docs/Models/Operations/Sort.md
View File

@@ -5,11 +5,11 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc | | `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false | | `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\ActiveDirection](../../Models/Operations/ActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `activeDirection` | [?Operations\ActiveDirection](../../Models/Operations/ActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `defaultDirection` | [?Operations\DefaultDirection](../../Models/Operations/DefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc | | `defaultDirection` | [?Operations\DefaultDirection](../../Models/Operations/DefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc | | `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter | | `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |

6
docs/Models/Operations/Stream.md
View File

@@ -7,11 +7,9 @@
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 | | `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 | | `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English | | `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en | | `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
@@ -45,6 +43,8 @@
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive | | `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 | | `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true | | `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |

2
docs/Models/Operations/Subscription.md
View File

@@ -9,7 +9,7 @@ If the account’s Plex Pass subscription is active
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | | | `features` | array<*string*> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true | | `active` | *?bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `status` | [?Operations\GetTokenDetailsAuthenticationStatus](../../Models/Operations/GetTokenDetailsAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z | | `subscribedAt` | *?string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `status` | [?Operations\GetTokenDetailsAuthenticationStatus](../../Models/Operations/GetTokenDetailsAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | | | `paymentService` | *?string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | | | `plan` | *?string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

10
docs/Models/Operations/User.md
View File

@@ -9,8 +9,8 @@
| `title` | *string* | :heavy_check_mark: | User's display name. | Plex User | | `title` | *string* | :heavy_check_mark: | User's display name. | Plex User |
| `username` | *string* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j | | `username` | *string* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j |
| `email` | *string* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com | | `email` | *string* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com |
| `recommendationsPlaylistId` | *?string* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
| `thumb` | *string* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 | | `thumb` | *string* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
| `server` | array<[Operations\GetUsersServer](../../Models/Operations/GetUsersServer.md)> | :heavy_check_mark: | List of servers owned by the user. | |
| `protected` | [?Operations\ProtectedT](../../Models/Operations/ProtectedT.md) | :heavy_minus_sign: | N/A | 1 | | `protected` | [?Operations\ProtectedT](../../Models/Operations/ProtectedT.md) | :heavy_minus_sign: | N/A | 1 |
| `home` | [?Operations\Home](../../Models/Operations/Home.md) | :heavy_minus_sign: | N/A | 1 | | `home` | [?Operations\Home](../../Models/Operations/Home.md) | :heavy_minus_sign: | N/A | 1 |
| `allowTuners` | [?Operations\AllowTuners](../../Models/Operations/AllowTuners.md) | :heavy_minus_sign: | N/A | 1 | | `allowTuners` | [?Operations\AllowTuners](../../Models/Operations/AllowTuners.md) | :heavy_minus_sign: | N/A | 1 |
@@ -18,10 +18,10 @@
| `allowCameraUpload` | [?Operations\AllowCameraUpload](../../Models/Operations/AllowCameraUpload.md) | :heavy_minus_sign: | N/A | 1 | | `allowCameraUpload` | [?Operations\AllowCameraUpload](../../Models/Operations/AllowCameraUpload.md) | :heavy_minus_sign: | N/A | 1 |
| `allowChannels` | [?Operations\AllowChannels](../../Models/Operations/AllowChannels.md) | :heavy_minus_sign: | N/A | 1 | | `allowChannels` | [?Operations\AllowChannels](../../Models/Operations/AllowChannels.md) | :heavy_minus_sign: | N/A | 1 |
| `allowSubtitleAdmin` | [?Operations\AllowSubtitleAdmin](../../Models/Operations/AllowSubtitleAdmin.md) | :heavy_minus_sign: | N/A | 1 | | `allowSubtitleAdmin` | [?Operations\AllowSubtitleAdmin](../../Models/Operations/AllowSubtitleAdmin.md) | :heavy_minus_sign: | N/A | 1 |
| `filterTelevision` | *?string* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [?Operations\Restricted](../../Models/Operations/Restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `recommendationsPlaylistId` | *?string* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
| `filterAll` | *?string* | :heavy_minus_sign: | Filters applied for all content. | | | `filterAll` | *?string* | :heavy_minus_sign: | Filters applied for all content. | |
| `filterMovies` | *?string* | :heavy_minus_sign: | Filters applied for movies. | | | `filterMovies` | *?string* | :heavy_minus_sign: | Filters applied for movies. | |
| `filterMusic` | *?string* | :heavy_minus_sign: | Filters applied for music. | | | `filterMusic` | *?string* | :heavy_minus_sign: | Filters applied for music. | |
| `filterPhotos` | *?string* | :heavy_minus_sign: | Filters applied for photos. | | | `filterPhotos` | *?string* | :heavy_minus_sign: | Filters applied for photos. | |
| `filterTelevision` | *?string* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [?Operations\Restricted](../../Models/Operations/Restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `server` | array<[Operations\GetUsersServer](../../Models/Operations/GetUsersServer.md)> | :heavy_check_mark: | List of servers owned by the user. | |

88
docs/sdks/activities/README.md
View File

@@ -14,8 +14,50 @@ Activities are optional cancellable. If cancellable, they may be cancelled via t
### Available Operations ### Available Operations
* [cancelServerActivities](#cancelserveractivities) - Cancel Server Activities
* [getServerActivities](#getserveractivities) - Get Server Activities * [getServerActivities](#getserveractivities) - Get Server Activities
* [cancelServerActivities](#cancelserveractivities) - Cancel Server Activities
## getServerActivities
Get Server Activities
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->activities->getServerActivities(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetServerActivitiesResponse](../../Models/Operations/GetServerActivitiesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| Errors\GetServerActivitiesBadRequest | 400 | application/json |
| Errors\GetServerActivitiesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## cancelServerActivities ## cancelServerActivities
@@ -63,46 +105,4 @@ if ($response->statusCode === 200) {
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| Errors\CancelServerActivitiesBadRequest | 400 | application/json | | Errors\CancelServerActivitiesBadRequest | 400 | application/json |
| Errors\CancelServerActivitiesUnauthorized | 401 | application/json | | Errors\CancelServerActivitiesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerActivities
Get Server Activities
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->activities->getServerActivities(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetServerActivitiesResponse](../../Models/Operations/GetServerActivitiesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| Errors\GetServerActivitiesBadRequest | 400 | application/json |
| Errors\GetServerActivitiesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

108
docs/sdks/authentication/README.md
View File

@@ -8,11 +8,64 @@ API Calls regarding authentication for Plex Media Server
### Available Operations ### Available Operations
* [getTransientToken](#gettransienttoken) - Get a Transient Token
* [getSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information * [getSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information
* [getTokenDetails](#gettokendetails) - Get Token Details * [getTokenDetails](#gettokendetails) - Get Token Details
* [getTransientToken](#gettransienttoken) - Get a Transient Token
* [postUsersSignInData](#postuserssignindata) - Get User Sign In Data * [postUsersSignInData](#postuserssignindata) - Get User Sign In Data
## getTransientToken
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->authentication->getTransientToken(
type: Operations\GetTransientTokenQueryParamType::Delegation,
scope: Operations\Scope::All
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\GetTransientTokenQueryParamType](../../Models/Operations/GetTransientTokenQueryParamType.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `scope` | [Operations\Scope](../../Models/Operations/Scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
### Response
**[?Operations\GetTransientTokenResponse](../../Models/Operations/GetTransientTokenResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| Errors\GetTransientTokenBadRequest | 400 | application/json |
| Errors\GetTransientTokenUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getSourceConnectionInformation ## getSourceConnectionInformation
If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
@@ -111,59 +164,6 @@ if ($response->userPlexAccount !== null) {
| Errors\GetTokenDetailsUnauthorized | 401 | application/json | | Errors\GetTokenDetailsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getTransientToken
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->authentication->getTransientToken(
type: Operations\GetTransientTokenQueryParamType::Delegation,
scope: Operations\Scope::All
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `type` | [Operations\GetTransientTokenQueryParamType](../../Models/Operations/GetTransientTokenQueryParamType.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `scope` | [Operations\Scope](../../Models/Operations/Scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
### Response
**[?Operations\GetTransientTokenResponse](../../Models/Operations/GetTransientTokenResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| Errors\GetTransientTokenBadRequest | 400 | application/json |
| Errors\GetTransientTokenUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## postUsersSignInData ## postUsersSignInData
Sign in user with username and password and return user data with Plex authentication token Sign in user with username and password and return user data with Plex authentication token

88
docs/sdks/butler/README.md
View File

@@ -10,8 +10,8 @@ Butler is the task manager of the Plex Media Server Ecosystem.
* [getButlerTasks](#getbutlertasks) - Get Butler tasks * [getButlerTasks](#getbutlertasks) - Get Butler tasks
* [startAllTasks](#startalltasks) - Start all Butler tasks * [startAllTasks](#startalltasks) - Start all Butler tasks
* [startTask](#starttask) - Start a single Butler task
* [stopAllTasks](#stopalltasks) - Stop all Butler tasks * [stopAllTasks](#stopalltasks) - Stop all Butler tasks
* [startTask](#starttask) - Start a single Butler task
* [stopTask](#stoptask) - Stop a single Butler task * [stopTask](#stoptask) - Stop a single Butler task
## getButlerTasks ## getButlerTasks
@@ -103,6 +103,49 @@ if ($response->statusCode === 200) {
| Errors\StartAllTasksUnauthorized | 401 | application/json | | Errors\StartAllTasksUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## stopAllTasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->butler->stopAllTasks(
);
if ($response->statusCode === 200) {
// handle response
}
```
### Response
**[?Operations\StopAllTasksResponse](../../Models/Operations/StopAllTasksResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| Errors\StopAllTasksBadRequest | 400 | application/json |
| Errors\StopAllTasksUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## startTask ## startTask
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria: This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
@@ -157,49 +200,6 @@ if ($response->statusCode === 200) {
| Errors\StartTaskUnauthorized | 401 | application/json | | Errors\StartTaskUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## stopAllTasks
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->butler->stopAllTasks(
);
if ($response->statusCode === 200) {
// handle response
}
```
### Response
**[?Operations\StopAllTasksResponse](../../Models/Operations/StopAllTasksResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| Errors\StopAllTasksBadRequest | 400 | application/json |
| Errors\StopAllTasksUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## stopTask ## stopTask
This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint. This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.

106
docs/sdks/hubs/README.md
View File

@@ -8,62 +8,10 @@ Hubs are a structured two-dimensional container for media, generally represented
### Available Operations ### Available Operations
* [getRecentlyAdded](#getrecentlyadded) - Get Recently Added
* [getGlobalHubs](#getglobalhubs) - Get Global Hubs * [getGlobalHubs](#getglobalhubs) - Get Global Hubs
* [getRecentlyAdded](#getrecentlyadded) - Get Recently Added
* [getLibraryHubs](#getlibraryhubs) - Get library specific hubs * [getLibraryHubs](#getlibraryhubs) - Get library specific hubs
## getRecentlyAdded
This endpoint will return the recently added content.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetRecentlyAddedRequest(
contentDirectoryID: 470161,
type: Operations\Type::TvShow,
sectionID: 2,
);
$response = $sdk->hubs->getRecentlyAdded(
request: $request
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetRecentlyAddedRequest](../../Models/Operations/GetRecentlyAddedRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetRecentlyAddedResponse](../../Models/Operations/GetRecentlyAddedResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------- | ------------------- | ------------------- |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getGlobalHubs ## getGlobalHubs
Get Global Hubs filtered by the parameters provided. Get Global Hubs filtered by the parameters provided.
@@ -116,6 +64,58 @@ if ($response->object !== null) {
| Errors\GetGlobalHubsUnauthorized | 401 | application/json | | Errors\GetGlobalHubsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getRecentlyAdded
This endpoint will return the recently added content.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetRecentlyAddedRequest(
contentDirectoryID: 470161,
sectionID: 2,
type: Operations\Type::TvShow,
);
$response = $sdk->hubs->getRecentlyAdded(
request: $request
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetRecentlyAddedRequest](../../Models/Operations/GetRecentlyAddedRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetRecentlyAddedResponse](../../Models/Operations/GetRecentlyAddedResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------- | ------------------- | ------------------- |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getLibraryHubs ## getLibraryHubs
This endpoint will return a list of library specific hubs This endpoint will return a list of library specific hubs

1134
docs/sdks/library/README.md
View File

File diff suppressed because it is too large Load Diff

90
docs/sdks/log/README.md
View File

@@ -8,52 +8,9 @@ Submit logs to the Log Handler for Plex Media Server
### Available Operations ### Available Operations
* [enablePaperTrail](#enablepapertrail) - Enabling Papertrail
* [logLine](#logline) - Logging a single line message. * [logLine](#logline) - Logging a single line message.
* [logMultiLine](#logmultiline) - Logging a multi-line message * [logMultiLine](#logmultiline) - Logging a multi-line message
* [enablePaperTrail](#enablepapertrail) - Enabling Papertrail
## enablePaperTrail
This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->log->enablePaperTrail(
);
if ($response->statusCode === 200) {
// handle response
}
```
### Response
**[?Operations\EnablePaperTrailResponse](../../Models/Operations/EnablePaperTrailResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\EnablePaperTrailBadRequest | 400 | application/json |
| Errors\EnablePaperTrailUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## logLine ## logLine
@@ -179,4 +136,47 @@ if ($response->statusCode === 200) {
| ------------------------------- | ------------------------------- | ------------------------------- | | ------------------------------- | ------------------------------- | ------------------------------- |
| Errors\LogMultiLineBadRequest | 400 | application/json | | Errors\LogMultiLineBadRequest | 400 | application/json |
| Errors\LogMultiLineUnauthorized | 401 | application/json | | Errors\LogMultiLineUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## enablePaperTrail
This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->log->enablePaperTrail(
);
if ($response->statusCode === 200) {
// handle response
}
```
### Response
**[?Operations\EnablePaperTrailResponse](../../Models/Operations/EnablePaperTrailResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\EnablePaperTrailBadRequest | 400 | application/json |
| Errors\EnablePaperTrailUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

230
docs/sdks/media/README.md
View File

@@ -8,123 +8,11 @@ API Calls interacting with Plex Media Server Media
### Available Operations ### Available Operations
* [getBannerImage](#getbannerimage) - Get Banner Image
* [getThumbImage](#getthumbimage) - Get Thumb Image
* [markPlayed](#markplayed) - Mark Media Played * [markPlayed](#markplayed) - Mark Media Played
* [markUnplayed](#markunplayed) - Mark Media Unplayed * [markUnplayed](#markunplayed) - Mark Media Unplayed
* [updatePlayProgress](#updateplayprogress) - Update Media Play Progress * [updatePlayProgress](#updateplayprogress) - Update Media Play Progress
* [getBannerImage](#getbannerimage) - Get Banner Image
## getBannerImage * [getThumbImage](#getthumbimage) - Get Thumb Image
Gets the banner image of the media item
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetBannerImageRequest(
ratingKey: 9518,
width: 396,
height: 396,
minSize: 1,
upscale: 1,
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);
$response = $sdk->media->getBannerImage(
request: $request
);
if ($response->bytes !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `$request` | [Operations\GetBannerImageRequest](../../Models/Operations/GetBannerImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetBannerImageResponse](../../Models/Operations/GetBannerImageResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\GetBannerImageBadRequest | 400 | application/json |
| Errors\GetBannerImageUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getThumbImage
Gets the thumbnail image of the media item
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetThumbImageRequest(
ratingKey: 9518,
width: 396,
height: 396,
minSize: 1,
upscale: 1,
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);
$response = $sdk->media->getThumbImage(
request: $request
);
if ($response->bytes !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `$request` | [Operations\GetThumbImageRequest](../../Models/Operations/GetThumbImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetThumbImageResponse](../../Models/Operations/GetThumbImageResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| Errors\GetThumbImageBadRequest | 400 | application/json |
| Errors\GetThumbImageUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## markPlayed ## markPlayed
@@ -274,4 +162,116 @@ if ($response->statusCode === 200) {
| ------------------------------------- | ------------------------------------- | ------------------------------------- | | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| Errors\UpdatePlayProgressBadRequest | 400 | application/json | | Errors\UpdatePlayProgressBadRequest | 400 | application/json |
| Errors\UpdatePlayProgressUnauthorized | 401 | application/json | | Errors\UpdatePlayProgressUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getBannerImage
Gets the banner image of the media item
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetBannerImageRequest(
ratingKey: 9518,
width: 396,
height: 396,
minSize: 1,
upscale: 1,
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);
$response = $sdk->media->getBannerImage(
request: $request
);
if ($response->bytes !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `$request` | [Operations\GetBannerImageRequest](../../Models/Operations/GetBannerImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetBannerImageResponse](../../Models/Operations/GetBannerImageResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\GetBannerImageBadRequest | 400 | application/json |
| Errors\GetBannerImageUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getThumbImage
Gets the thumbnail image of the media item
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$request = new Operations\GetThumbImageRequest(
ratingKey: 9518,
width: 396,
height: 396,
minSize: 1,
upscale: 1,
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);
$response = $sdk->media->getThumbImage(
request: $request
);
if ($response->bytes !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `$request` | [Operations\GetThumbImageRequest](../../Models/Operations/GetThumbImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[?Operations\GetThumbImageResponse](../../Models/Operations/GetThumbImageResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| Errors\GetThumbImageBadRequest | 400 | application/json |
| Errors\GetThumbImageUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

388
docs/sdks/playlists/README.md
View File

@@ -11,120 +11,16 @@ This may cause the duration and number of items to change.
### Available Operations ### Available Operations
* [addPlaylistContents](#addplaylistcontents) - Adding to a Playlist
* [clearPlaylistContents](#clearplaylistcontents) - Delete Playlist Contents
* [createPlaylist](#createplaylist) - Create a Playlist * [createPlaylist](#createplaylist) - Create a Playlist
* [deletePlaylist](#deleteplaylist) - Deletes a Playlist
* [getPlaylist](#getplaylist) - Retrieve Playlist
* [getPlaylistContents](#getplaylistcontents) - Retrieve Playlist Contents
* [getPlaylists](#getplaylists) - Get All Playlists * [getPlaylists](#getplaylists) - Get All Playlists
* [getPlaylist](#getplaylist) - Retrieve Playlist
* [deletePlaylist](#deleteplaylist) - Deletes a Playlist
* [updatePlaylist](#updateplaylist) - Update a Playlist * [updatePlaylist](#updateplaylist) - Update a Playlist
* [getPlaylistContents](#getplaylistcontents) - Retrieve Playlist Contents
* [clearPlaylistContents](#clearplaylistcontents) - Delete Playlist Contents
* [addPlaylistContents](#addplaylistcontents) - Adding to a Playlist
* [uploadPlaylist](#uploadplaylist) - Upload Playlist * [uploadPlaylist](#uploadplaylist) - Upload Playlist
## addPlaylistContents
Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->addPlaylistContents(
playlistID: 8502.01,
uri: 'server://12345/com.plexapp.plugins.library/library/metadata/1',
playQueueID: 123
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlistID` | *float* | :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` | *?float* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
### Response
**[?Operations\AddPlaylistContentsResponse](../../Models/Operations/AddPlaylistContentsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| Errors\AddPlaylistContentsBadRequest | 400 | application/json |
| Errors\AddPlaylistContentsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## clearPlaylistContents
Clears a playlist, only works with dumb playlists. Returns the playlist.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->clearPlaylistContents(
playlistID: 1893.18
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist |
### Response
**[?Operations\ClearPlaylistContentsResponse](../../Models/Operations/ClearPlaylistContentsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| Errors\ClearPlaylistContentsBadRequest | 400 | application/json |
| Errors\ClearPlaylistContentsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## createPlaylist ## createPlaylist
Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
@@ -182,10 +78,9 @@ if ($response->object !== null) {
| Errors\CreatePlaylistUnauthorized | 401 | application/json | | Errors\CreatePlaylistUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## deletePlaylist ## getPlaylists
This endpoint will delete a playlist
Get All Playlists given the specified filters.
### Example Usage ### Example Usage
@@ -195,6 +90,7 @@ declare(strict_types=1);
require 'vendor/autoload.php'; require 'vendor/autoload.php';
use LukeHagar\Plex_API; use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder() $sdk = Plex_API\PlexAPI::builder()
->setSecurity( ->setSecurity(
@@ -204,32 +100,35 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->playlists->deletePlaylist( $response = $sdk->playlists->getPlaylists(
playlistID: 216.22 playlistType: Operations\PlaylistType::Audio,
smart: Operations\QueryParamSmart::Zero
); );
if ($response->statusCode === 200) { if ($response->object !== null) {
// handle response // handle response
} }
``` ```
### Parameters ### Parameters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist | | `playlistType` | [?Operations\PlaylistType](../../Models/Operations/PlaylistType.md) | :heavy_minus_sign: | limit to a type of playlist. |
| `smart` | [?Operations\QueryParamSmart](../../Models/Operations/QueryParamSmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). |
### Response ### Response
**[?Operations\DeletePlaylistResponse](../../Models/Operations/DeletePlaylistResponse.md)** **[?Operations\GetPlaylistsResponse](../../Models/Operations/GetPlaylistsResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- | | ------------------------------- | ------------------------------- | ------------------------------- |
| Errors\DeletePlaylistBadRequest | 400 | application/json | | Errors\GetPlaylistsBadRequest | 400 | application/json |
| Errors\DeletePlaylistUnauthorized | 401 | application/json | | Errors\GetPlaylistsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getPlaylist ## getPlaylist
@@ -281,6 +180,109 @@ if ($response->object !== null) {
| Errors\GetPlaylistUnauthorized | 401 | application/json | | Errors\GetPlaylistUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## deletePlaylist
This endpoint will delete a playlist
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->deletePlaylist(
playlistID: 216.22
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist |
### Response
**[?Operations\DeletePlaylistResponse](../../Models/Operations/DeletePlaylistResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\DeletePlaylistBadRequest | 400 | application/json |
| Errors\DeletePlaylistUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## updatePlaylist
From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->updatePlaylist(
playlistID: 3915,
title: '<value>',
summary: '<value>'
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist |
| `title` | *?string* | :heavy_minus_sign: | name of the playlist |
| `summary` | *?string* | :heavy_minus_sign: | summary description of the playlist |
### Response
**[?Operations\UpdatePlaylistResponse](../../Models/Operations/UpdatePlaylistResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\UpdatePlaylistBadRequest | 400 | application/json |
| Errors\UpdatePlaylistUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getPlaylistContents ## getPlaylistContents
Gets the contents of a playlist. Should be paged by clients via standard mechanisms. Gets the contents of a playlist. Should be paged by clients via standard mechanisms.
@@ -337,9 +339,10 @@ if ($response->object !== null) {
| Errors\GetPlaylistContentsUnauthorized | 401 | application/json | | Errors\GetPlaylistContentsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getPlaylists ## clearPlaylistContents
Clears a playlist, only works with dumb playlists. Returns the playlist.
Get All Playlists given the specified filters.
### Example Usage ### Example Usage
@@ -349,7 +352,6 @@ declare(strict_types=1);
require 'vendor/autoload.php'; require 'vendor/autoload.php';
use LukeHagar\Plex_API; use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder() $sdk = Plex_API\PlexAPI::builder()
->setSecurity( ->setSecurity(
@@ -359,9 +361,60 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->playlists->getPlaylists( $response = $sdk->playlists->clearPlaylistContents(
playlistType: Operations\PlaylistType::Audio, playlistID: 1893.18
smart: Operations\QueryParamSmart::Zero );
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist |
### Response
**[?Operations\ClearPlaylistContentsResponse](../../Models/Operations/ClearPlaylistContentsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| Errors\ClearPlaylistContentsBadRequest | 400 | application/json |
| Errors\ClearPlaylistContentsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## addPlaylistContents
Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist.
With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->addPlaylistContents(
playlistID: 8502.01,
uri: 'server://12345/com.plexapp.plugins.library/library/metadata/1',
playQueueID: 123
); );
@@ -372,76 +425,23 @@ if ($response->object !== null) {
### Parameters ### Parameters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlistType` | [?Operations\PlaylistType](../../Models/Operations/PlaylistType.md) | :heavy_minus_sign: | limit to a type of playlist. | | `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist | |
| `smart` | [?Operations\QueryParamSmart](../../Models/Operations/QueryParamSmart.md) | :heavy_minus_sign: | type of playlists to return (default is all). | | `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `playQueueID` | *?float* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |
### Response ### Response
**[?Operations\GetPlaylistsResponse](../../Models/Operations/GetPlaylistsResponse.md)** **[?Operations\AddPlaylistContentsResponse](../../Models/Operations/AddPlaylistContentsResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- | | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| Errors\GetPlaylistsBadRequest | 400 | application/json | | Errors\AddPlaylistContentsBadRequest | 400 | application/json |
| Errors\GetPlaylistsUnauthorized | 401 | application/json | | Errors\AddPlaylistContentsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## updatePlaylist
From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/{playlistID}`
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->playlists->updatePlaylist(
playlistID: 3915,
title: '<value>',
summary: '<value>'
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `playlistID` | *float* | :heavy_check_mark: | the ID of the playlist |
| `title` | *?string* | :heavy_minus_sign: | name of the playlist |
| `summary` | *?string* | :heavy_minus_sign: | summary description of the playlist |
### Response
**[?Operations\UpdatePlaylistResponse](../../Models/Operations/UpdatePlaylistResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\UpdatePlaylistBadRequest | 400 | application/json |
| Errors\UpdatePlaylistUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## uploadPlaylist ## uploadPlaylist

216
docs/sdks/plex/README.md
View File

@@ -8,70 +8,13 @@ API Calls that perform operations directly against https://Plex.tv
### Available Operations ### Available Operations
* [getServerResources](#getserverresources) - Get Server Resources
* [getCompanionsData](#getcompanionsdata) - Get Companions Data * [getCompanionsData](#getcompanionsdata) - Get Companions Data
* [getUserFriends](#getuserfriends) - Get list of friends of the user logged in
* [getGeoData](#getgeodata) - Get Geo Data * [getGeoData](#getgeodata) - Get Geo Data
* [getHomeData](#gethomedata) - Get Plex Home Data * [getHomeData](#gethomedata) - Get Plex Home Data
* [getServerResources](#getserverresources) - Get Server Resources
* [getPin](#getpin) - Get a Pin * [getPin](#getpin) - Get a Pin
* [getTokenByPinId](#gettokenbypinid) - Get Access Token by PinId * [getTokenByPinId](#gettokenbypinid) - Get Access Token by PinId
* [getUserFriends](#getuserfriends) - Get list of friends of the user logged in
## getServerResources
Get Plex server access tokens and server connections
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->plex->getServerResources(
clientID: '3381b62b-9ab7-4e37-827b-203e9809eb58',
includeHttps: Operations\IncludeHttps::Enable,
includeRelay: Operations\IncludeRelay::Enable,
includeIPv6: Operations\IncludeIPv6::Enable
);
if ($response->plexDevices !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[?Operations\GetServerResourcesResponse](../../Models/Operations/GetServerResourcesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| Errors\GetServerResourcesBadRequest | 400 | application/json |
| Errors\GetServerResourcesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getCompanionsData ## getCompanionsData
@@ -121,6 +64,54 @@ if ($response->responseBodies !== null) {
| Errors\GetCompanionsDataUnauthorized | 401 | application/json | | Errors\GetCompanionsDataUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getUserFriends
Get friends of provided auth token.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->plex->getUserFriends(
);
if ($response->friends !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[?Operations\GetUserFriendsResponse](../../Models/Operations/GetUserFriendsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\GetUserFriendsBadRequest | 400 | application/json |
| Errors\GetUserFriendsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getGeoData ## getGeoData
Returns the geolocation and locale data of the caller Returns the geolocation and locale data of the caller
@@ -207,6 +198,63 @@ if ($response->object !== null) {
| Errors\GetHomeDataUnauthorized | 401 | application/json | | Errors\GetHomeDataUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerResources
Get Plex server access tokens and server connections
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->plex->getServerResources(
clientID: '3381b62b-9ab7-4e37-827b-203e9809eb58',
includeHttps: Operations\IncludeHttps::Enable,
includeRelay: Operations\IncludeRelay::Enable,
includeIPv6: Operations\IncludeIPv6::Enable
);
if ($response->plexDevices !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[?Operations\GetServerResourcesResponse](../../Models/Operations/GetServerResourcesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| Errors\GetServerResourcesBadRequest | 400 | application/json |
| Errors\GetServerResourcesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getPin ## getPin
Retrieve a Pin ID from Plex.tv to use for authentication flows Retrieve a Pin ID from Plex.tv to use for authentication flows
@@ -309,52 +357,4 @@ if ($response->authPinContainer !== null) {
| ---------------------------------- | ---------------------------------- | ---------------------------------- | | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| Errors\GetTokenByPinIdBadRequest | 400 | application/json | | Errors\GetTokenByPinIdBadRequest | 400 | application/json |
| Errors\GetTokenByPinIdResponseBody | 404 | application/json | | Errors\GetTokenByPinIdResponseBody | 404 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getUserFriends
Get friends of provided auth token.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->plex->getUserFriends(
);
if ($response->friends !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[?Operations\GetUserFriendsResponse](../../Models/Operations/GetUserFriendsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| Errors\GetUserFriendsBadRequest | 400 | application/json |
| Errors\GetUserFriendsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

100
docs/sdks/search/README.md
View File

@@ -8,57 +8,9 @@ API Calls that perform search operations with Plex Media Server
### Available Operations ### Available Operations
* [getSearchResults](#getsearchresults) - Get Search Results
* [performSearch](#performsearch) - Perform a search * [performSearch](#performsearch) - Perform a search
* [performVoiceSearch](#performvoicesearch) - Perform a voice search * [performVoiceSearch](#performvoicesearch) - Perform a voice search
* [getSearchResults](#getsearchresults) - Get Search Results
## getSearchResults
This will search the database for the string provided.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->search->getSearchResults(
query: '110'
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `query` | *string* | :heavy_check_mark: | The search query string to use | 110 |
### Response
**[?Operations\GetSearchResultsResponse](../../Models/Operations/GetSearchResultsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\GetSearchResultsBadRequest | 400 | application/json |
| Errors\GetSearchResultsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## performSearch ## performSearch
@@ -180,4 +132,52 @@ if ($response->statusCode === 200) {
| ------------------------------------- | ------------------------------------- | ------------------------------------- | | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| Errors\PerformVoiceSearchBadRequest | 400 | application/json | | Errors\PerformVoiceSearchBadRequest | 400 | application/json |
| Errors\PerformVoiceSearchUnauthorized | 401 | application/json | | Errors\PerformVoiceSearchUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getSearchResults
This will search the database for the string provided.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->search->getSearchResults(
query: '110'
);
if ($response->object !== null) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `query` | *string* | :heavy_check_mark: | The search query string to use | 110 |
### Response
**[?Operations\GetSearchResultsResponse](../../Models/Operations/GetSearchResultsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| Errors\GetSearchResultsBadRequest | 400 | application/json |
| Errors\GetSearchResultsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

164
docs/sdks/server/README.md
View File

@@ -8,19 +8,19 @@ Operations against the Plex Media Server System.
### Available Operations ### Available Operations
* [getMediaProviders](#getmediaproviders) - Get Media Providers * [getServerCapabilities](#getservercapabilities) - Get Server Capabilities
* [getServerIdentity](#getserveridentity) - Get Server Identity * [getServerPreferences](#getserverpreferences) - Get Server Preferences
* [getAvailableClients](#getavailableclients) - Get Available Clients * [getAvailableClients](#getavailableclients) - Get Available Clients
* [getDevices](#getdevices) - Get Devices * [getDevices](#getdevices) - Get Devices
* [getServerIdentity](#getserveridentity) - Get Server Identity
* [getMyPlexAccount](#getmyplexaccount) - Get MyPlex Account * [getMyPlexAccount](#getmyplexaccount) - Get MyPlex Account
* [getResizedPhoto](#getresizedphoto) - Get a Resized Photo * [getResizedPhoto](#getresizedphoto) - Get a Resized Photo
* [getServerCapabilities](#getservercapabilities) - Get Server Capabilities * [getMediaProviders](#getmediaproviders) - Get Media Providers
* [getServerList](#getserverlist) - Get Server List * [getServerList](#getserverlist) - Get Server List
* [getServerPreferences](#getserverpreferences) - Get Server Preferences
## getMediaProviders ## getServerCapabilities
Retrieves media providers and their features from the Plex server. Get Server Capabilities
### Example Usage ### Example Usage
@@ -39,8 +39,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getMediaProviders( $response = $sdk->server->getServerCapabilities(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
@@ -48,27 +48,21 @@ if ($response->object !== null) {
} }
``` ```
### Parameters
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
### Response ### Response
**[?Operations\GetMediaProvidersResponse](../../Models/Operations/GetMediaProvidersResponse.md)** **[?Operations\GetServerCapabilitiesResponse](../../Models/Operations/GetServerCapabilitiesResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| Errors\GetMediaProvidersBadRequest | 400 | application/json | | Errors\GetServerCapabilitiesBadRequest | 400 | application/json |
| Errors\GetMediaProvidersUnauthorized | 401 | application/json | | Errors\GetServerCapabilitiesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerIdentity ## getServerPreferences
This request is useful to determine if the server is online or offline Get Server Preferences
### Example Usage ### Example Usage
@@ -79,11 +73,15 @@ require 'vendor/autoload.php';
use LukeHagar\Plex_API; use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()->build(); $sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->server->getServerIdentity( $response = $sdk->server->getServerPreferences(
); );
@@ -94,14 +92,15 @@ if ($response->object !== null) {
### Response ### Response
**[?Operations\GetServerIdentityResponse](../../Models/Operations/GetServerIdentityResponse.md)** **[?Operations\GetServerPreferencesResponse](../../Models/Operations/GetServerPreferencesResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| Errors\GetServerIdentityRequestTimeout | 408 | application/json | | Errors\GetServerPreferencesBadRequest | 400 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\GetServerPreferencesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getAvailableClients ## getAvailableClients
@@ -187,6 +186,43 @@ if ($response->object !== null) {
| Errors\GetDevicesUnauthorized | 401 | application/json | | Errors\GetDevicesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerIdentity
This request is useful to determine if the server is online or offline
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()->build();
$response = $sdk->server->getServerIdentity(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetServerIdentityResponse](../../Models/Operations/GetServerIdentityResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| Errors\GetServerIdentityRequestTimeout | 408 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getMyPlexAccount ## getMyPlexAccount
Returns MyPlex Account Information Returns MyPlex Account Information
@@ -287,9 +323,9 @@ if ($response->statusCode === 200) {
| Errors\GetResizedPhotoUnauthorized | 401 | application/json | | Errors\GetResizedPhotoUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerCapabilities ## getMediaProviders
Get Server Capabilities Retrieves media providers and their features from the Plex server.
### Example Usage ### Example Usage
@@ -308,8 +344,8 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->server->getServerCapabilities( $response = $sdk->server->getMediaProviders(
xPlexToken: 'CV5xoxjTpFKUzBTShsaf'
); );
if ($response->object !== null) { if ($response->object !== null) {
@@ -317,17 +353,23 @@ if ($response->object !== null) {
} }
``` ```
### Parameters
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `xPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
### Response ### Response
**[?Operations\GetServerCapabilitiesResponse](../../Models/Operations/GetServerCapabilitiesResponse.md)** **[?Operations\GetMediaProvidersResponse](../../Models/Operations/GetMediaProvidersResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| Errors\GetServerCapabilitiesBadRequest | 400 | application/json | | Errors\GetMediaProvidersBadRequest | 400 | application/json |
| Errors\GetServerCapabilitiesUnauthorized | 401 | application/json | | Errors\GetMediaProvidersUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerList ## getServerList
@@ -369,46 +411,4 @@ if ($response->object !== null) {
| -------------------------------- | -------------------------------- | -------------------------------- | | -------------------------------- | -------------------------------- | -------------------------------- |
| Errors\GetServerListBadRequest | 400 | application/json | | Errors\GetServerListBadRequest | 400 | application/json |
| Errors\GetServerListUnauthorized | 401 | application/json | | Errors\GetServerListUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getServerPreferences
Get Server Preferences
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->server->getServerPreferences(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetServerPreferencesResponse](../../Models/Operations/GetServerPreferencesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| Errors\GetServerPreferencesBadRequest | 400 | application/json |
| Errors\GetServerPreferencesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

86
docs/sdks/sessions/README.md
View File

@@ -8,11 +8,53 @@ API Calls that perform search operations with Plex Media Server Sessions
### Available Operations ### Available Operations
* [getSessionHistory](#getsessionhistory) - Get Session History
* [getSessions](#getsessions) - Get Active Sessions * [getSessions](#getsessions) - Get Active Sessions
* [getSessionHistory](#getsessionhistory) - Get Session History
* [getTranscodeSessions](#gettranscodesessions) - Get Transcode Sessions * [getTranscodeSessions](#gettranscodesessions) - Get Transcode Sessions
* [stopTranscodeSession](#stoptranscodesession) - Stop a Transcode Session * [stopTranscodeSession](#stoptranscodesession) - Stop a Transcode Session
## getSessions
This will retrieve the "Now Playing" Information of the PMS.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->sessions->getSessions(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetSessionsResponse](../../Models/Operations/GetSessionsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| Errors\GetSessionsBadRequest | 400 | application/json |
| Errors\GetSessionsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getSessionHistory ## getSessionHistory
This will Retrieve a listing of all history views. This will Retrieve a listing of all history views.
@@ -69,48 +111,6 @@ if ($response->object !== null) {
| Errors\GetSessionHistoryUnauthorized | 401 | application/json | | Errors\GetSessionHistoryUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getSessions
This will retrieve the "Now Playing" Information of the PMS.
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->sessions->getSessions(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetSessionsResponse](../../Models/Operations/GetSessionsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| Errors\GetSessionsBadRequest | 400 | application/json |
| Errors\GetSessionsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getTranscodeSessions ## getTranscodeSessions
Get Transcode Sessions Get Transcode Sessions

40
docs/sdks/statistics/README.md
View File

@@ -8,13 +8,13 @@ API Calls that perform operations with Plex Media Server Statistics
### Available Operations ### Available Operations
* [getBandwidthStatistics](#getbandwidthstatistics) - Get Bandwidth Statistics
* [getResourcesStatistics](#getresourcesstatistics) - Get Resources Statistics
* [getStatistics](#getstatistics) - Get Media Statistics * [getStatistics](#getstatistics) - Get Media Statistics
* [getResourcesStatistics](#getresourcesstatistics) - Get Resources Statistics
* [getBandwidthStatistics](#getbandwidthstatistics) - Get Bandwidth Statistics
## getBandwidthStatistics ## getStatistics
This will return the bandwidth statistics for the server This will return the media statistics for the server
### Example Usage ### Example Usage
@@ -33,7 +33,7 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->statistics->getBandwidthStatistics( $response = $sdk->statistics->getStatistics(
timespan: 4 timespan: 4
); );
@@ -50,15 +50,15 @@ if ($response->object !== null) {
### Response ### Response
**[?Operations\GetBandwidthStatisticsResponse](../../Models/Operations/GetBandwidthStatisticsResponse.md)** **[?Operations\GetStatisticsResponse](../../Models/Operations/GetStatisticsResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | | -------------------------------- | -------------------------------- | -------------------------------- |
| Errors\GetBandwidthStatisticsBadRequest | 400 | application/json | | Errors\GetStatisticsBadRequest | 400 | application/json |
| Errors\GetBandwidthStatisticsUnauthorized | 401 | application/json | | Errors\GetStatisticsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getResourcesStatistics ## getResourcesStatistics
@@ -108,9 +108,9 @@ if ($response->object !== null) {
| Errors\GetResourcesStatisticsUnauthorized | 401 | application/json | | Errors\GetResourcesStatisticsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## getStatistics ## getBandwidthStatistics
This will return the media statistics for the server This will return the bandwidth statistics for the server
### Example Usage ### Example Usage
@@ -129,7 +129,7 @@ $sdk = Plex_API\PlexAPI::builder()
$response = $sdk->statistics->getStatistics( $response = $sdk->statistics->getBandwidthStatistics(
timespan: 4 timespan: 4
); );
@@ -146,12 +146,12 @@ if ($response->object !== null) {
### Response ### Response
**[?Operations\GetStatisticsResponse](../../Models/Operations/GetStatisticsResponse.md)** **[?Operations\GetBandwidthStatisticsResponse](../../Models/Operations/GetBandwidthStatisticsResponse.md)**
### Errors ### Errors
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| Errors\GetStatisticsBadRequest | 400 | application/json | | Errors\GetBandwidthStatisticsBadRequest | 400 | application/json |
| Errors\GetStatisticsUnauthorized | 401 | application/json | | Errors\GetBandwidthStatisticsUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |

188
docs/sdks/updater/README.md
View File

@@ -9,9 +9,100 @@ Updates to the status can be observed via the Event API.
### Available Operations ### Available Operations
* [applyUpdates](#applyupdates) - Apply Updates
* [checkForUpdates](#checkforupdates) - Checking for updates
* [getUpdateStatus](#getupdatestatus) - Querying status of updates * [getUpdateStatus](#getupdatestatus) - Querying status of updates
* [checkForUpdates](#checkforupdates) - Checking for updates
* [applyUpdates](#applyupdates) - Apply Updates
## getUpdateStatus
Querying status of updates
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->updater->getUpdateStatus(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetUpdateStatusResponse](../../Models/Operations/GetUpdateStatusResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| Errors\GetUpdateStatusBadRequest | 400 | application/json |
| Errors\GetUpdateStatusUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## checkForUpdates
Checking for updates
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->updater->checkForUpdates(
download: Operations\Download::One
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `download` | [?Operations\Download](../../Models/Operations/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
**[?Operations\CheckForUpdatesResponse](../../Models/Operations/CheckForUpdatesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| Errors\CheckForUpdatesBadRequest | 400 | application/json |
| Errors\CheckForUpdatesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## applyUpdates ## applyUpdates
@@ -64,95 +155,4 @@ if ($response->statusCode === 200) {
| ------------------------------- | ------------------------------- | ------------------------------- | | ------------------------------- | ------------------------------- | ------------------------------- |
| Errors\ApplyUpdatesBadRequest | 400 | application/json | | Errors\ApplyUpdatesBadRequest | 400 | application/json |
| Errors\ApplyUpdatesUnauthorized | 401 | application/json | | Errors\ApplyUpdatesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* | | Errors\SDKException | 4XX, 5XX | \*/\* |
## checkForUpdates
Checking for updates
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->updater->checkForUpdates(
download: Operations\Download::One
);
if ($response->statusCode === 200) {
// handle response
}
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `download` | [?Operations\Download](../../Models/Operations/Download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |
### Response
**[?Operations\CheckForUpdatesResponse](../../Models/Operations/CheckForUpdatesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| Errors\CheckForUpdatesBadRequest | 400 | application/json |
| Errors\CheckForUpdatesUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |
## getUpdateStatus
Querying status of updates
### Example Usage
```php
declare(strict_types=1);
require 'vendor/autoload.php';
use LukeHagar\Plex_API;
$sdk = Plex_API\PlexAPI::builder()
->setSecurity(
'<YOUR_API_KEY_HERE>'
)
->build();
$response = $sdk->updater->getUpdateStatus(
);
if ($response->object !== null) {
// handle response
}
```
### Response
**[?Operations\GetUpdateStatusResponse](../../Models/Operations/GetUpdateStatusResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| Errors\GetUpdateStatusBadRequest | 400 | application/json |
| Errors\GetUpdateStatusUnauthorized | 401 | application/json |
| Errors\SDKException | 4XX, 5XX | \*/\* |

2
docs/sdks/users/README.md
View File

@@ -25,7 +25,6 @@ $sdk = Plex_API\PlexAPI::builder()->build();
$request = new Operations\GetUsersRequest( $request = new Operations\GetUsersRequest(
clientID: '3381b62b-9ab7-4e37-827b-203e9809eb58', clientID: '3381b62b-9ab7-4e37-827b-203e9809eb58',
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
clientName: 'Plex for Roku', clientName: 'Plex for Roku',
deviceNickname: 'Roku 3', deviceNickname: 'Roku 3',
deviceName: 'Chrome', deviceName: 'Chrome',
@@ -37,6 +36,7 @@ $request = new Operations\GetUsersRequest(
xPlexSessionId: '97e136ef-4ddd-4ff3-89a7-a5820c96c2ca', xPlexSessionId: '97e136ef-4ddd-4ff3-89a7-a5820c96c2ca',
xPlexLanguage: 'en', xPlexLanguage: 'en',
platformVersion: '4.3 build 1057', platformVersion: '4.3 build 1057',
xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
); );
$response = $sdk->users->getUsers( $response = $sdk->users->getUsers(

65
src/Models/Operations/GetAllLibrariesDirectory.php
View File

@@ -12,6 +12,7 @@ namespace LukeHagar\Plex_API\Models\Operations;
class GetAllLibrariesDirectory class GetAllLibrariesDirectory
{ {
/** /**
* Indicates whether syncing is allowed.
* *
* @var bool $allowSync * @var bool $allowSync
*/ */
@@ -19,6 +20,7 @@ class GetAllLibrariesDirectory
public bool $allowSync; public bool $allowSync;
/** /**
* URL for the background artwork of the media container.
* *
* @var string $art * @var string $art
*/ */
@@ -26,6 +28,7 @@ class GetAllLibrariesDirectory
public string $art; public string $art;
/** /**
* The relative path to the composite media item.
* *
* @var string $composite * @var string $composite
*/ */
@@ -33,6 +36,7 @@ class GetAllLibrariesDirectory
public string $composite; public string $composite;
/** /**
* UNKNOWN
* *
* @var bool $filters * @var bool $filters
*/ */
@@ -40,6 +44,7 @@ class GetAllLibrariesDirectory
public bool $filters; public bool $filters;
/** /**
* Indicates whether the library is currently being refreshed or updated
* *
* @var bool $refreshing * @var bool $refreshing
*/ */
@@ -47,6 +52,7 @@ class GetAllLibrariesDirectory
public bool $refreshing; public bool $refreshing;
/** /**
* URL for the thumbnail image of the media container.
* *
* @var string $thumb * @var string $thumb
*/ */
@@ -54,6 +60,7 @@ class GetAllLibrariesDirectory
public string $thumb; public string $thumb;
/** /**
* The library key representing the unique identifier
* *
* @var string $key * @var string $key
*/ */
@@ -62,12 +69,14 @@ class GetAllLibrariesDirectory
/** /**
* *
* @var string $type * @var GetAllLibrariesType $type
*/ */
#[\Speakeasy\Serializer\Annotation\SerializedName('type')] #[\Speakeasy\Serializer\Annotation\SerializedName('type')]
public string $type; #[\Speakeasy\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesType')]
public GetAllLibrariesType $type;
/** /**
* The title of the library
* *
* @var string $title * @var string $title
*/ */
@@ -75,6 +84,7 @@ class GetAllLibrariesDirectory
public string $title; public string $title;
/** /**
* The Plex agent used to match and retrieve media metadata.
* *
* @var string $agent * @var string $agent
*/ */
@@ -82,6 +92,7 @@ class GetAllLibrariesDirectory
public string $agent; public string $agent;
/** /**
* UNKNOWN
* *
* @var string $scanner * @var string $scanner
*/ */
@@ -89,6 +100,7 @@ class GetAllLibrariesDirectory
public string $scanner; public string $scanner;
/** /**
* The Plex library language that has been set
* *
* @var string $language * @var string $language
*/ */
@@ -96,6 +108,7 @@ class GetAllLibrariesDirectory
public string $language; public string $language;
/** /**
* The universally unique identifier for the library.
* *
* @var string $uuid * @var string $uuid
*/ */
@@ -110,14 +123,6 @@ class GetAllLibrariesDirectory
#[\Speakeasy\Serializer\Annotation\SerializedName('updatedAt')] #[\Speakeasy\Serializer\Annotation\SerializedName('updatedAt')]
public int $updatedAt; public int $updatedAt;
/**
* Unix epoch datetime in seconds
*
* @var int $createdAt
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('createdAt')]
public int $createdAt;
/** /**
* Unix epoch datetime in seconds * Unix epoch datetime in seconds
* *
@@ -127,6 +132,7 @@ class GetAllLibrariesDirectory
public int $scannedAt; public int $scannedAt;
/** /**
* UNKNOWN
* *
* @var bool $content * @var bool $content
*/ */
@@ -134,6 +140,7 @@ class GetAllLibrariesDirectory
public bool $content; public bool $content;
/** /**
* UNKNOWN
* *
* @var bool $directory * @var bool $directory
*/ */
@@ -141,20 +148,13 @@ class GetAllLibrariesDirectory
public bool $directory; public bool $directory;
/** /**
* Unix epoch datetime in seconds * The number of seconds since the content was last changed relative to now.
* *
* @var int $contentChangedAt * @var int $contentChangedAt
*/ */
#[\Speakeasy\Serializer\Annotation\SerializedName('contentChangedAt')] #[\Speakeasy\Serializer\Annotation\SerializedName('contentChangedAt')]
public int $contentChangedAt; public int $contentChangedAt;
/**
*
* @var int $hidden
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('hidden')]
public int $hidden;
/** /**
* $location * $location
* *
@@ -164,6 +164,23 @@ class GetAllLibrariesDirectory
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesLocation>')] #[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesLocation>')]
public array $location; public array $location;
/**
*
* @var ?int $createdAt
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('createdAt')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?int $createdAt = null;
/**
*
* @var ?Hidden $hidden
*/
#[\Speakeasy\Serializer\Annotation\SerializedName('hidden')]
#[\Speakeasy\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\Hidden|null')]
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?Hidden $hidden = null;
/** /**
* @param bool $allowSync * @param bool $allowSync
* @param string $art * @param string $art
@@ -172,23 +189,23 @@ class GetAllLibrariesDirectory
* @param bool $refreshing * @param bool $refreshing
* @param string $thumb * @param string $thumb
* @param string $key * @param string $key
* @param string $type * @param GetAllLibrariesType $type
* @param string $title * @param string $title
* @param string $agent * @param string $agent
* @param string $scanner * @param string $scanner
* @param string $language * @param string $language
* @param string $uuid * @param string $uuid
* @param int $updatedAt * @param int $updatedAt
* @param int $createdAt
* @param int $scannedAt * @param int $scannedAt
* @param bool $content * @param bool $content
* @param bool $directory * @param bool $directory
* @param int $contentChangedAt * @param int $contentChangedAt
* @param int $hidden
* @param array<GetAllLibrariesLocation> $location * @param array<GetAllLibrariesLocation> $location
* @param ?int $createdAt
* @param ?Hidden $hidden
* @phpstan-pure * @phpstan-pure
*/ */
public function __construct(bool $allowSync, string $art, string $composite, bool $filters, bool $refreshing, string $thumb, string $key, string $type, string $title, string $agent, string $scanner, string $language, string $uuid, int $updatedAt, int $createdAt, int $scannedAt, bool $content, bool $directory, int $contentChangedAt, int $hidden, array $location) public function __construct(bool $allowSync, string $art, string $composite, bool $filters, bool $refreshing, string $thumb, string $key, GetAllLibrariesType $type, string $title, string $agent, string $scanner, string $language, string $uuid, int $updatedAt, int $scannedAt, bool $content, bool $directory, int $contentChangedAt, array $location, ?int $createdAt = null, ?Hidden $hidden = Hidden::Disable)
{ {
$this->allowSync = $allowSync; $this->allowSync = $allowSync;
$this->art = $art; $this->art = $art;
@@ -204,12 +221,12 @@ class GetAllLibrariesDirectory
$this->language = $language; $this->language = $language;
$this->uuid = $uuid; $this->uuid = $uuid;
$this->updatedAt = $updatedAt; $this->updatedAt = $updatedAt;
$this->createdAt = $createdAt;
$this->scannedAt = $scannedAt; $this->scannedAt = $scannedAt;
$this->content = $content; $this->content = $content;
$this->directory = $directory; $this->directory = $directory;
$this->contentChangedAt = $contentChangedAt; $this->contentChangedAt = $contentChangedAt;
$this->hidden = $hidden;
$this->location = $location; $this->location = $location;
$this->createdAt = $createdAt;
$this->hidden = $hidden;
} }
} }

2
src/Models/Operations/GetAllLibrariesLocation.php
View File

@@ -12,6 +12,7 @@ namespace LukeHagar\Plex_API\Models\Operations;
class GetAllLibrariesLocation class GetAllLibrariesLocation
{ {
/** /**
* The ID of the location.
* *
* @var int $id * @var int $id
*/ */
@@ -19,6 +20,7 @@ class GetAllLibrariesLocation
public int $id; public int $id;
/** /**
* The path to the media item.
* *
* @var string $path * @var string $path
*/ */

14
src/Models/Operations/GetAllLibrariesMediaContainer.php
View File

@@ -12,6 +12,7 @@ namespace LukeHagar\Plex_API\Models\Operations;
class GetAllLibrariesMediaContainer class GetAllLibrariesMediaContainer
{ {
/** /**
* Number of media items returned in this response.
* *
* @var int $size * @var int $size
*/ */
@@ -19,6 +20,7 @@ class GetAllLibrariesMediaContainer
public int $size; public int $size;
/** /**
* Indicates whether syncing is allowed.
* *
* @var bool $allowSync * @var bool $allowSync
*/ */
@@ -26,6 +28,7 @@ class GetAllLibrariesMediaContainer
public bool $allowSync; public bool $allowSync;
/** /**
* The primary title of the media container.
* *
* @var string $title1 * @var string $title1
*/ */
@@ -35,20 +38,21 @@ class GetAllLibrariesMediaContainer
/** /**
* $directory * $directory
* *
* @var array<GetAllLibrariesDirectory> $directory * @var ?array<GetAllLibrariesDirectory> $directory
*/ */
#[\Speakeasy\Serializer\Annotation\SerializedName('Directory')] #[\Speakeasy\Serializer\Annotation\SerializedName('Directory')]
#[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesDirectory>')] #[\Speakeasy\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesDirectory>|null')]
public array $directory; #[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?array $directory = null;
/** /**
* @param int $size * @param int $size
* @param bool $allowSync * @param bool $allowSync
* @param string $title1 * @param string $title1
* @param array<GetAllLibrariesDirectory> $directory * @param ?array<GetAllLibrariesDirectory> $directory
* @phpstan-pure * @phpstan-pure
*/ */
public function __construct(int $size, bool $allowSync, string $title1, array $directory) public function __construct(int $size, bool $allowSync, string $title1, ?array $directory = null)
{ {
$this->size = $size; $this->size = $size;
$this->allowSync = $allowSync; $this->allowSync = $allowSync;

11
src/Models/Operations/GetAllLibrariesResponseBody.php
View File

@@ -14,17 +14,18 @@ class GetAllLibrariesResponseBody
{ {
/** /**
* *
* @var GetAllLibrariesMediaContainer $mediaContainer * @var ?GetAllLibrariesMediaContainer $mediaContainer
*/ */
#[\Speakeasy\Serializer\Annotation\SerializedName('MediaContainer')] #[\Speakeasy\Serializer\Annotation\SerializedName('MediaContainer')]
#[\Speakeasy\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesMediaContainer')] #[\Speakeasy\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesMediaContainer|null')]
public GetAllLibrariesMediaContainer $mediaContainer; #[\Speakeasy\Serializer\Annotation\SkipWhenNull]
public ?GetAllLibrariesMediaContainer $mediaContainer = null;
/** /**
* @param GetAllLibrariesMediaContainer $mediaContainer * @param ?GetAllLibrariesMediaContainer $mediaContainer
* @phpstan-pure * @phpstan-pure
*/ */
public function __construct(GetAllLibrariesMediaContainer $mediaContainer) public function __construct(?GetAllLibrariesMediaContainer $mediaContainer = null)
{ {
$this->mediaContainer = $mediaContainer; $this->mediaContainer = $mediaContainer;
} }

21
src/Models/Operations/GetAllLibrariesType.php Normal file
View File

@@ -0,0 +1,21 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** The library type */
enum GetAllLibrariesType: string
{
case Movie = 'movie';
case TvShow = 'show';
case Season = 'season';
case Episode = 'episode';
case Artist = 'artist';
case Album = 'album';
}

17
src/Models/Operations/Hidden.php Normal file
View File

@@ -0,0 +1,17 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** UNKNOWN */
enum Hidden: int
{
case Disable = 0;
case Enable = 1;
}

2
src/PlexAPI.php
View File

@@ -43,7 +43,7 @@ class PlexAPI
{ {
public const SERVERS = [ public const SERVERS = [
/** The full address of your Plex Server */ /** The full address of your Plex Server */
'{protocol}://{ip}:{port}', 'https://10.10.10.47:32400',
]; ];
/** /**

6
src/SDKConfiguration.php
View File

@@ -33,11 +33,11 @@ class SDKConfiguration
public string $openapiDocVersion = '0.0.3'; public string $openapiDocVersion = '0.0.3';
public string $sdkVersion = '0.14.3'; public string $sdkVersion = '0.14.4';
public string $genVersion = '2.565.1'; public string $genVersion = '2.566.5';
public string $userAgent = 'speakeasy-sdk/php 0.14.3 2.565.1 0.0.3 lukehagar/plex-api'; public string $userAgent = 'speakeasy-sdk/php 0.14.4 2.566.5 0.0.3 lukehagar/plex-api';
public ?RetryConfig $retryConfig = null; public ?RetryConfig $retryConfig = null;