mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-06 04:20:51 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.397.2
This commit is contained in:
3440
.speakeasy/gen.lock
3440
.speakeasy/gen.lock
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: false
|
oAuth2ClientCredentialsEnabled: false
|
||||||
php:
|
php:
|
||||||
version: 0.7.0
|
version: 0.8.0
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
imports:
|
imports:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.362.0
|
speakeasyVersion: 1.397.2
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -7,29 +7,37 @@ sources:
|
|||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
- main
|
||||||
|
plexapi:
|
||||||
|
sourceNamespace: plexapi
|
||||||
|
sourceRevisionDigest: sha256:533fe97486e3fe2d84e890b7bbcdba4543d415e45181386154e011861f6da36f
|
||||||
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- main
|
||||||
targets:
|
targets:
|
||||||
plexphp:
|
plexphp:
|
||||||
source: my-source
|
source: plexapi
|
||||||
sourceNamespace: my-source
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:c655e586ae918fdfeb2a0e48f44dd0d83a60834c56b12cda70cc1b6e41a30680
|
sourceRevisionDigest: sha256:533fe97486e3fe2d84e890b7bbcdba4543d415e45181386154e011861f6da36f
|
||||||
sourceBlobDigest: sha256:e7c91bb1aed0f6cc3284fef94ec096c89c1c88c5a256ca9d0d032de67180fdd8
|
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
|
||||||
codeSamplesNamespace: code-samples-php-plexphp
|
codeSamplesNamespace: code-samples-php-plexphp
|
||||||
codeSamplesRevisionDigest: sha256:b7885c14977a7f51b434eba5a7fa83a28455dfa4bfd20a8ab04319dfbace7417
|
codeSamplesRevisionDigest: sha256:09c3a7a54c93941a76a6e929193153781dfd0468455ab492b9650f410d8e8c4c
|
||||||
outLocation: /github/workspace/repo
|
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
plexapi:
|
||||||
inputs:
|
inputs:
|
||||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
|
||||||
registry:
|
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
|
||||||
targets:
|
targets:
|
||||||
plexphp:
|
plexphp:
|
||||||
target: php
|
target: php
|
||||||
source: my-source
|
source: plexapi
|
||||||
|
publish:
|
||||||
|
packagist:
|
||||||
|
username: LukeHagar
|
||||||
|
token: $packagist_token
|
||||||
codeSamples:
|
codeSamples:
|
||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-php-plexphp
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-php-plexphp
|
||||||
|
|||||||
223
README.md
223
README.md
@@ -7,31 +7,30 @@
|
|||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- Start Summary [summary] -->
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||||
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
|
<!-- Start Table of Contents [toc] -->
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
* [SDK Installation](#sdk-installation)
|
||||||
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
|
* [Global Parameters](#global-parameters)
|
||||||
|
* [Server Selection](#server-selection)
|
||||||
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
<!-- Start SDK Installation [installation] -->
|
<!-- Start SDK Installation [installation] -->
|
||||||
## SDK Installation
|
## SDK Installation
|
||||||
|
|
||||||
### Composer
|
The SDK relies on [Composer](https://getcomposer.org/) to manage its dependencies.
|
||||||
|
|
||||||
To install the SDK first add the below to your `composer.json` file:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"repositories": [
|
|
||||||
{
|
|
||||||
"type": "github",
|
|
||||||
"url": "https://github.com/LukeHagar/plexphp.git"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"require": {
|
|
||||||
"lukehagar/plex-api": "*"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Then run the following command:
|
|
||||||
|
|
||||||
|
To install the SDK and add it as a dependency to an existing `composer.json` file:
|
||||||
```bash
|
```bash
|
||||||
composer update
|
composer require "lukehagar/plex-api"
|
||||||
```
|
```
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
@@ -48,11 +47,12 @@ require 'vendor/autoload.php';
|
|||||||
use LukeHagar\Plex_API;
|
use LukeHagar\Plex_API;
|
||||||
use LukeHagar\Plex_API\Models\Components;
|
use LukeHagar\Plex_API\Models\Components;
|
||||||
|
|
||||||
$security = new Components\Security();
|
$security = new Components\Security(
|
||||||
$security->accessToken = '<YOUR_API_KEY_HERE>';
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
);
|
||||||
|
|
||||||
$sdk = Plex_API\PlexAPI::builder()
|
$sdk = Plex_API\PlexAPI::builder()
|
||||||
->setXPlexClientIdentifier('Postman')
|
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
|
||||||
->setSecurity($security)->build();
|
->setSecurity($security)->build();
|
||||||
|
|
||||||
try {
|
try {
|
||||||
@@ -70,33 +70,21 @@ try {
|
|||||||
<!-- Start Available Resources and Operations [operations] -->
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
## Available Resources and Operations
|
## Available Resources and Operations
|
||||||
|
|
||||||
### [Server](docs/sdks/server/README.md)
|
<details open>
|
||||||
|
<summary>Available methods</summary>
|
||||||
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
|
||||||
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
|
||||||
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
|
||||||
* [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
|
|
||||||
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
|
||||||
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
|
||||||
|
|
||||||
### [Media](docs/sdks/media/README.md)
|
|
||||||
|
|
||||||
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
|
||||||
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
|
||||||
* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
|
|
||||||
|
|
||||||
### [Video](docs/sdks/video/README.md)
|
|
||||||
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
|
||||||
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
|
||||||
|
|
||||||
### [Activities](docs/sdks/activities/README.md)
|
### [Activities](docs/sdks/activities/README.md)
|
||||||
|
|
||||||
* [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
|
* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
|
||||||
|
|
||||||
|
### [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
|
||||||
|
* [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
|
||||||
|
* [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
|
||||||
@@ -105,34 +93,22 @@ try {
|
|||||||
* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
|
* [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
|
||||||
|
|
||||||
### [Plex](docs/sdks/plex/README.md)
|
|
||||||
|
|
||||||
* [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
|
|
||||||
* [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin
|
|
||||||
* [getToken](docs/sdks/plex/README.md#gettoken) - Get Access Token
|
|
||||||
|
|
||||||
### [Hubs](docs/sdks/hubs/README.md)
|
### [Hubs](docs/sdks/hubs/README.md)
|
||||||
|
|
||||||
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
|
||||||
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||||
|
|
||||||
### [Search](docs/sdks/search/README.md)
|
|
||||||
|
|
||||||
* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
|
|
||||||
* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
|
|
||||||
* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
|
|
||||||
|
|
||||||
### [Library](docs/sdks/library/README.md)
|
### [Library](docs/sdks/library/README.md)
|
||||||
|
|
||||||
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||||
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
|
||||||
* [getLibraries](docs/sdks/library/README.md#getlibraries) - Get All Libraries
|
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||||
* [getLibrary](docs/sdks/library/README.md#getlibrary) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [searchLibrary](docs/sdks/library/README.md#searchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
|
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||||
* [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
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
@@ -143,6 +119,14 @@ try {
|
|||||||
* [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
|
* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
|
||||||
|
|
||||||
|
### [Media](docs/sdks/media/README.md)
|
||||||
|
|
||||||
|
* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
|
||||||
|
* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
|
||||||
|
* [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)
|
||||||
|
|
||||||
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
|
||||||
@@ -155,16 +139,34 @@ try {
|
|||||||
* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
|
* [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
|
||||||
|
|
||||||
### [Authentication](docs/sdks/authentication/README.md)
|
### [Plex](docs/sdks/plex/README.md)
|
||||||
|
|
||||||
* [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token.
|
* [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
|
||||||
* [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
|
* [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
|
||||||
|
* [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
|
||||||
|
* [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
|
||||||
|
|
||||||
### [Statistics](docs/sdks/statistics/README.md)
|
|
||||||
|
|
||||||
* [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
|
### [Search](docs/sdks/search/README.md)
|
||||||
* [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
|
|
||||||
* [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
|
* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a 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)
|
||||||
|
|
||||||
|
* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
|
||||||
|
* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
|
||||||
|
* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
|
||||||
|
* [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
|
||||||
|
* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
|
||||||
|
* [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
|
||||||
|
* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
|
||||||
|
|
||||||
### [Sessions](docs/sdks/sessions/README.md)
|
### [Sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
@@ -173,17 +175,82 @@ try {
|
|||||||
* [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)
|
||||||
|
|
||||||
|
* [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)
|
||||||
|
|
||||||
* [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
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [Video](docs/sdks/video/README.md)
|
||||||
|
|
||||||
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
|
* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
|
||||||
|
|
||||||
### [Watchlist](docs/sdks/watchlist/README.md)
|
### [Watchlist](docs/sdks/watchlist/README.md)
|
||||||
|
|
||||||
* [getWatchlist](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
* [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
|
||||||
|
|
||||||
|
</details>
|
||||||
<!-- End Available Resources and Operations [operations] -->
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Global Parameters [global-parameters] -->
|
||||||
|
## Global Parameters
|
||||||
|
|
||||||
|
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||||
|
|
||||||
|
For example, you can set `X-Plex-Client-Identifier` to `'gcgzw5rz2xovp84b4vha3a40'` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
|
### Available Globals
|
||||||
|
|
||||||
|
The following global parameter is available.
|
||||||
|
|
||||||
|
| Name | Type | Required | Description |
|
||||||
|
| ---- | ---- |:--------:| ----------- |
|
||||||
|
| xPlexClientIdentifier | string | | The unique identifier for the client application
|
||||||
|
This is used to track the client application and its usage
|
||||||
|
(UUID, serial number, or other number unique per device)
|
||||||
|
|
|
||||||
|
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```php
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
require 'vendor/autoload.php';
|
||||||
|
|
||||||
|
use LukeHagar\Plex_API;
|
||||||
|
use LukeHagar\Plex_API\Models\Components;
|
||||||
|
use LukeHagar\Plex_API\Models\Operations;
|
||||||
|
|
||||||
|
$security = new Components\Security(
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
);
|
||||||
|
|
||||||
|
$sdk = Plex_API\PlexAPI::builder()
|
||||||
|
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
|
||||||
|
->setSecurity($security)->build();
|
||||||
|
|
||||||
|
try {
|
||||||
|
|
||||||
|
$response = $sdk->plex->getServerResources('gcgzw5rz2xovp84b4vha3a40', Operations\IncludeHttps::One, Operations\IncludeRelay::One, Operations\IncludeIPv6::One);
|
||||||
|
|
||||||
|
if ($response->plexDevices !== null) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
// handle exception
|
||||||
|
}
|
||||||
|
```
|
||||||
|
<!-- End Global Parameters [global-parameters] -->
|
||||||
|
|
||||||
<!-- Start Server Selection [server] -->
|
<!-- Start Server Selection [server] -->
|
||||||
## Server Selection
|
## Server Selection
|
||||||
|
|
||||||
@@ -195,14 +262,14 @@ You can override the default server globally by passing a server index to the `s
|
|||||||
|
|
||||||
| # | Server | Variables |
|
| # | Server | Variables |
|
||||||
| - | ------ | --------- |
|
| - | ------ | --------- |
|
||||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Variables
|
#### Variables
|
||||||
|
|
||||||
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
|
||||||
* `protocol: ServerProtocol`
|
* `protocol: Plex_API\ServerProtocol`
|
||||||
* `ip: string`
|
* `ip: string`
|
||||||
* `port: string`
|
* `port: string`
|
||||||
|
|
||||||
@@ -220,16 +287,20 @@ 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\Components;
|
||||||
|
|
||||||
|
$security = new Components\Security(
|
||||||
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
);
|
||||||
|
|
||||||
$sdk = Plex_API\PlexAPI::builder()
|
$sdk = Plex_API\PlexAPI::builder()
|
||||||
->setXPlexClientIdentifier('Postman')
|
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
|
||||||
->build();
|
->setSecurity($security)->build();
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
$response = $sdk->plex->getCompanionsData("https://plex.tv/api/v2/");
|
||||||
|
|
||||||
$response = $sdk->plex->getPin("https://plex.tv/api/v2", 'Postman', false, 'Postman');
|
if ($response->responseBodies !== null) {
|
||||||
|
|
||||||
if ($response->object !== null) {
|
|
||||||
// handle response
|
// handle response
|
||||||
}
|
}
|
||||||
} catch (Throwable $e) {
|
} catch (Throwable $e) {
|
||||||
|
|||||||
12
RELEASES.md
12
RELEASES.md
@@ -582,4 +582,14 @@ Based on:
|
|||||||
- OpenAPI Doc
|
- OpenAPI Doc
|
||||||
- Speakeasy CLI 1.362.0 (2.393.4) https://github.com/speakeasy-api/speakeasy
|
- Speakeasy CLI 1.362.0 (2.393.4) https://github.com/speakeasy-api/speakeasy
|
||||||
### Generated
|
### Generated
|
||||||
- [php v0.7.0] .
|
- [php v0.7.0] .
|
||||||
|
|
||||||
|
## 2024-09-16 18:43:13
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.397.2 (2.415.8) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [php v0.8.0] .
|
||||||
|
### Releases
|
||||||
|
- [Composer v0.8.0] https://packagist.org/packages/lukehagar/plex-api#v0.8.0 - .
|
||||||
7
USAGE.md
7
USAGE.md
@@ -7,11 +7,12 @@ require 'vendor/autoload.php';
|
|||||||
use LukeHagar\Plex_API;
|
use LukeHagar\Plex_API;
|
||||||
use LukeHagar\Plex_API\Models\Components;
|
use LukeHagar\Plex_API\Models\Components;
|
||||||
|
|
||||||
$security = new Components\Security();
|
$security = new Components\Security(
|
||||||
$security->accessToken = '<YOUR_API_KEY_HERE>';
|
accessToken: "<YOUR_API_KEY_HERE>",
|
||||||
|
);
|
||||||
|
|
||||||
$sdk = Plex_API\PlexAPI::builder()
|
$sdk = Plex_API\PlexAPI::builder()
|
||||||
->setXPlexClientIdentifier('Postman')
|
->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
|
||||||
->setSecurity($security)->build();
|
->setSecurity($security)->build();
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
|||||||
3252
codeSamples.yaml
3252
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -7,16 +7,10 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"repositories": [
|
|
||||||
{
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/idbentley/serializer"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"require": {
|
"require": {
|
||||||
"php": "^8.1",
|
"php": "^8.1",
|
||||||
"guzzlehttp/guzzle": "^7.0",
|
"guzzlehttp/guzzle": "^7.0",
|
||||||
"jms/serializer": "dev-deserialize-unions",
|
"speakeasy/serializer": "^3.40.0",
|
||||||
"brick/date-time": "^0.7.0",
|
"brick/date-time": "^0.7.0",
|
||||||
"phpdocumentor/type-resolver": "^1.8"
|
"phpdocumentor/type-resolver": "^1.8"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# AddPlaylistContentsResponseBody
|
# AddPlaylistContentsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/AddPlaylistContentsPlaylistsErrors.md
Normal file
10
docs/Models/Errors/AddPlaylistContentsPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# AddPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/AddPlaylistContentsUnauthorized.md
Normal file
11
docs/Models/Errors/AddPlaylistContentsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AddPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | array<[Errors\AddPlaylistContentsPlaylistsErrors](../../Models/Errors/AddPlaylistContentsPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# ApplyUpdatesResponseBody
|
# ApplyUpdatesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/Models/Errors/ApplyUpdatesUnauthorized.md
Normal file
11
docs/Models/Errors/ApplyUpdatesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ApplyUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\ApplyUpdatesUpdaterErrors](../../Models/Errors/ApplyUpdatesUpdaterErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/ApplyUpdatesUpdaterErrors.md
Normal file
10
docs/Models/Errors/ApplyUpdatesUpdaterErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ApplyUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
10
docs/Models/Errors/CancelServerActivitiesActivitiesErrors.md
Normal file
10
docs/Models/Errors/CancelServerActivitiesActivitiesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CancelServerActivitiesActivitiesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# CancelServerActivitiesResponseBody
|
# CancelServerActivitiesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/Models/Errors/CancelServerActivitiesUnauthorized.md
Normal file
11
docs/Models/Errors/CancelServerActivitiesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CancelServerActivitiesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | array<[Errors\CancelServerActivitiesActivitiesErrors](../../Models/Errors/CancelServerActivitiesActivitiesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# CheckForUpdatesResponseBody
|
# CheckForUpdatesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/Models/Errors/CheckForUpdatesUnauthorized.md
Normal file
11
docs/Models/Errors/CheckForUpdatesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CheckForUpdatesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\CheckForUpdatesUpdaterErrors](../../Models/Errors/CheckForUpdatesUpdaterErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/CheckForUpdatesUpdaterErrors.md
Normal file
10
docs/Models/Errors/CheckForUpdatesUpdaterErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CheckForUpdatesUpdaterErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# ClearPlaylistContentsResponseBody
|
# ClearPlaylistContentsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/ClearPlaylistContentsPlaylistsErrors.md
Normal file
10
docs/Models/Errors/ClearPlaylistContentsPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ClearPlaylistContentsPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/ClearPlaylistContentsUnauthorized.md
Normal file
11
docs/Models/Errors/ClearPlaylistContentsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ClearPlaylistContentsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | array<[Errors\ClearPlaylistContentsPlaylistsErrors](../../Models/Errors/ClearPlaylistContentsPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# CreatePlaylistResponseBody
|
# CreatePlaylistBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/CreatePlaylistPlaylistsErrors.md
Normal file
10
docs/Models/Errors/CreatePlaylistPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreatePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/CreatePlaylistUnauthorized.md
Normal file
11
docs/Models/Errors/CreatePlaylistUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CreatePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\CreatePlaylistPlaylistsErrors](../../Models/Errors/CreatePlaylistPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# DeleteLibraryResponseBody
|
# DeleteLibraryBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/DeleteLibraryLibraryErrors.md
Normal file
10
docs/Models/Errors/DeleteLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeleteLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/DeleteLibraryUnauthorized.md
Normal file
11
docs/Models/Errors/DeleteLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DeleteLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\DeleteLibraryLibraryErrors](../../Models/Errors/DeleteLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# DeletePlaylistResponseBody
|
# DeletePlaylistBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/DeletePlaylistPlaylistsErrors.md
Normal file
10
docs/Models/Errors/DeletePlaylistPlaylistsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# DeletePlaylistPlaylistsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/DeletePlaylistUnauthorized.md
Normal file
11
docs/Models/Errors/DeletePlaylistUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# DeletePlaylistUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\DeletePlaylistPlaylistsErrors](../../Models/Errors/DeletePlaylistPlaylistsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# EnablePaperTrailResponseBody
|
# EnablePaperTrailBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/EnablePaperTrailLogErrors.md
Normal file
10
docs/Models/Errors/EnablePaperTrailLogErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# EnablePaperTrailLogErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/EnablePaperTrailUnauthorized.md
Normal file
11
docs/Models/Errors/EnablePaperTrailUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# EnablePaperTrailUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\EnablePaperTrailLogErrors](../../Models/Errors/EnablePaperTrailLogErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/Models/Errors/GetAllLibrariesBadRequest.md
Normal file
11
docs/Models/Errors/GetAllLibrariesBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllLibrariesBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetAllLibrariesErrors](../../Models/Errors/GetAllLibrariesErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/GetAllLibrariesErrors.md
Normal file
10
docs/Models/Errors/GetAllLibrariesErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetAllLibrariesLibraryErrors.md
Normal file
10
docs/Models/Errors/GetAllLibrariesLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllLibrariesLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetAllLibrariesUnauthorized.md
Normal file
11
docs/Models/Errors/GetAllLibrariesUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllLibrariesUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetAllLibrariesLibraryErrors](../../Models/Errors/GetAllLibrariesLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetAvailableClientsResponseBody
|
# GetAvailableClientsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetAvailableClientsServerErrors.md
Normal file
10
docs/Models/Errors/GetAvailableClientsServerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAvailableClientsServerErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetAvailableClientsUnauthorized.md
Normal file
11
docs/Models/Errors/GetAvailableClientsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAvailableClientsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetAvailableClientsServerErrors](../../Models/Errors/GetAvailableClientsServerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetBandwidthStatisticsResponseBody
|
# GetBandwidthStatisticsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetBandwidthStatisticsStatisticsErrors.md
Normal file
10
docs/Models/Errors/GetBandwidthStatisticsStatisticsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetBandwidthStatisticsStatisticsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetBandwidthStatisticsUnauthorized.md
Normal file
11
docs/Models/Errors/GetBandwidthStatisticsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetBandwidthStatisticsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `errors` | array<[Errors\GetBandwidthStatisticsStatisticsErrors](../../Models/Errors/GetBandwidthStatisticsStatisticsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/Models/Errors/GetBannerImageBadRequest.md
Normal file
11
docs/Models/Errors/GetBannerImageBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetBannerImageBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetBannerImageErrors](../../Models/Errors/GetBannerImageErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/GetBannerImageErrors.md
Normal file
10
docs/Models/Errors/GetBannerImageErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetBannerImageErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetBannerImageMediaErrors.md
Normal file
10
docs/Models/Errors/GetBannerImageMediaErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetBannerImageMediaErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetBannerImageUnauthorized.md
Normal file
11
docs/Models/Errors/GetBannerImageUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetBannerImageUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetBannerImageMediaErrors](../../Models/Errors/GetBannerImageMediaErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/Models/Errors/GetButlerTasksBadRequest.md
Normal file
11
docs/Models/Errors/GetButlerTasksBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetButlerTasksBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetButlerTasksErrors](../../Models/Errors/GetButlerTasksErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/GetButlerTasksButlerErrors.md
Normal file
10
docs/Models/Errors/GetButlerTasksButlerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetButlerTasksButlerErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/Models/Errors/GetButlerTasksUnauthorized.md
Normal file
11
docs/Models/Errors/GetButlerTasksUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetButlerTasksUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetButlerTasksButlerErrors](../../Models/Errors/GetButlerTasksButlerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/Models/Errors/GetCompanionsDataBadRequest.md
Normal file
11
docs/Models/Errors/GetCompanionsDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetCompanionsDataBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetCompanionsDataErrors](../../Models/Errors/GetCompanionsDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/GetCompanionsDataErrors.md
Normal file
10
docs/Models/Errors/GetCompanionsDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCompanionsDataErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetCompanionsDataPlexErrors.md
Normal file
10
docs/Models/Errors/GetCompanionsDataPlexErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetCompanionsDataPlexErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetCompanionsDataUnauthorized.md
Normal file
11
docs/Models/Errors/GetCompanionsDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetCompanionsDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetCompanionsDataPlexErrors](../../Models/Errors/GetCompanionsDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetDevicesResponseBody
|
# GetDevicesBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetDevicesServerErrors.md
Normal file
10
docs/Models/Errors/GetDevicesServerErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetDevicesServerErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetRecentlyAddedResponseBody
|
# GetDevicesUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetRecentlyAddedErrors](../../Models/Errors/GetRecentlyAddedErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetDevicesServerErrors](../../Models/Errors/GetDevicesServerErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetFileHashResponseBody
|
# GetFileHashBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetFileHashLibraryErrors.md
Normal file
10
docs/Models/Errors/GetFileHashLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetFileHashLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetLibraryResponseBody
|
# GetFileHashUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetLibraryErrors](../../Models/Errors/GetLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetFileHashLibraryErrors](../../Models/Errors/GetFileHashLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# GetTokenResponseBody
|
# GetGeoDataBadRequest
|
||||||
|
|
||||||
X-Plex-Client-Identifier is missing
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetTokenErrors](../../Models/Errors/GetTokenErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetGeoDataErrors](../../Models/Errors/GetGeoDataErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
# GetTokenErrors
|
# GetGeoDataErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1000 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 400 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
# GetLibrariesErrors
|
# GetGeoDataPlexErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetButlerTasksResponseBody
|
# GetGeoDataUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetButlerTasksErrors](../../Models/Errors/GetButlerTasksErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetGeoDataPlexErrors](../../Models/Errors/GetGeoDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetGlobalHubsResponseBody
|
# GetGlobalHubsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
# GetServerIdentityErrors
|
# GetGlobalHubsHubsErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetServerIdentityResponseBody
|
# GetGlobalHubsUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetServerIdentityErrors](../../Models/Errors/GetServerIdentityErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetGlobalHubsHubsErrors](../../Models/Errors/GetGlobalHubsHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetHomeDataResponseBody
|
# GetHomeDataBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
# GetWatchlistErrors
|
# GetHomeDataPlexErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetResizedPhotoResponseBody
|
# GetHomeDataUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | array<[Errors\GetResizedPhotoErrors](../../Models/Errors/GetResizedPhotoErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | array<[Errors\GetHomeDataPlexErrors](../../Models/Errors/GetHomeDataPlexErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/Models/Errors/GetLibraryDetailsBadRequest.md
Normal file
11
docs/Models/Errors/GetLibraryDetailsBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryDetailsBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetLibraryDetailsErrors](../../Models/Errors/GetLibraryDetailsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/Models/Errors/GetLibraryDetailsErrors.md
Normal file
10
docs/Models/Errors/GetLibraryDetailsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryDetailsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetLibraryDetailsLibraryErrors.md
Normal file
10
docs/Models/Errors/GetLibraryDetailsLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryDetailsLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetLibraryDetailsUnauthorized.md
Normal file
11
docs/Models/Errors/GetLibraryDetailsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryDetailsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetLibraryDetailsLibraryErrors](../../Models/Errors/GetLibraryDetailsLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetLibraryHubsResponseBody
|
# GetLibraryHubsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetLibraryHubsHubsErrors.md
Normal file
10
docs/Models/Errors/GetLibraryHubsHubsErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryHubsHubsErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/Models/Errors/GetLibraryHubsUnauthorized.md
Normal file
11
docs/Models/Errors/GetLibraryHubsUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibraryHubsUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | array<[Errors\GetLibraryHubsHubsErrors](../../Models/Errors/GetLibraryHubsHubsErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetLibraryItemsResponseBody
|
# GetLibraryItemsBadRequest
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
| `code` | *?float* | :heavy_minus_sign: | N/A | 1001 |
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
| `status` | *?float* | :heavy_minus_sign: | N/A | 401 |
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/Models/Errors/GetLibraryItemsLibraryErrors.md
Normal file
10
docs/Models/Errors/GetLibraryItemsLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user