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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2

Browse Source
This commit is contained in:
speakeasybot
2024-09-21 00:10:22 +00:00
parent 6c77be1c96
commit 9b3a44d1f4
107 changed files with 1253 additions and 766 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
.speakeasy/gen.lock
View File

File diff suppressed because one or more lines are too long

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
php:
version: 0.8.1
version: 0.9.0
clientServerStatusCodesAsErrors: true
flattenGlobalSecurity: true
imports:

14
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.399.2
speakeasyVersion: 1.401.2
sources:
my-source:
sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
sourceRevisionDigest: sha256:5aa71ad96ca6de91143ee513c9880e08e555e7748fb4b5f8d069c6ab0c8f3069
sourceBlobDigest: sha256:1cbef844e2856c2eabba4bd6d677d96c572fed13b27978d0d953aa06b224c02f
tags:
- latest
- main
@@ -18,10 +18,10 @@ targets:
plexphp:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
sourceRevisionDigest: sha256:5aa71ad96ca6de91143ee513c9880e08e555e7748fb4b5f8d069c6ab0c8f3069
sourceBlobDigest: sha256:1cbef844e2856c2eabba4bd6d677d96c572fed13b27978d0d953aa06b224c02f
codeSamplesNamespace: code-samples-php-plexphp
codeSamplesRevisionDigest: sha256:a2463615fc3539369b1f3f0ba5ac302f6ff3566f1ddbd0194adf7a4a8dc098c0
codeSamplesRevisionDigest: sha256:31c36f98b0d052576648992aa27009ef7e202960cecc266347879d0f7cb26855
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
@@ -35,7 +35,7 @@ workflow:
source: plexapi
publish:
packagist:
username: LukeHagar
username: lukehagar
token: $packagist_token
codeSamples:
output: codeSamples.yaml

15
README.md
View File

@@ -208,7 +208,7 @@ try {
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `ClientID` 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.
For example, you can set `ClientID` to `'gcgzw5rz2xovp84b4vha3a40'` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. 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
@@ -235,26 +235,21 @@ 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()
->setClientID('gcgzw5rz2xovp84b4vha3a40')
->setClientName('Plex Web')
->setClientVersion('4.133.0')
->setClientPlatform('Chrome')
->setDeviceName('Linux')
->setSecurity($security)->build();
->build();
try {
$request = new Operations\GetPinRequest();
$response = $sdk->plex->getPin($request);
$response = $sdk->plex->getServerResources('gcgzw5rz2xovp84b4vha3a40', Operations\IncludeHttps::One, Operations\IncludeRelay::One, Operations\IncludeIPv6::One);
if ($response->plexDevices !== null) {
if ($response->authPinContainer !== null) {
// handle response
}
} catch (Throwable $e) {

12
RELEASES.md
View File

@@ -602,4 +602,14 @@ Based on:
### Generated
- [php v0.8.1] .
### Releases
- [Composer v0.8.1] https://packagist.org/packages/lukehagar/plex-api#v0.8.1 - .
- [Composer v0.8.1] https://packagist.org/packages/lukehagar/plex-api#v0.8.1 - .
## 2024-09-21 00:08:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.9.0] .
### Releases
- [Composer v0.9.0] https://packagist.org/packages/lukehagar/plex-api#v0.9.0 - .

44
codeSamples.yaml
View File

@@ -728,7 +728,7 @@ actions:
try {
$response = $sdk->search->performSearch('arnold', 9372.7, 5);
$response = $sdk->search->performSearch('dylan', 5838.67, 5);
if ($response->statusCode === 200) {
// handle response
@@ -763,7 +763,7 @@ actions:
try {
$response = $sdk->search->performVoiceSearch('dead+poop', 4094.8, 5);
$response = $sdk->search->performVoiceSearch('dead+poop', 4094.80, 5);
if ($response->statusCode === 200) {
// handle response
@@ -799,7 +799,7 @@ actions:
try {
$response = $sdk->hubs->getLibraryHubs(6728.76, 9010.22, Operations\QueryParamOnlyTransient::Zero);
$response = $sdk->hubs->getLibraryHubs(6728.76, 639.24, Operations\QueryParamOnlyTransient::One);
if ($response->object !== null) {
// handle response
@@ -864,7 +864,7 @@ actions:
try {
$response = $sdk->library->getTopWatchedContent(Operations\GetTopWatchedContentQueryParamType::Two, 1);
$response = $sdk->library->getTopWatchedContent(Operations\GetTopWatchedContentQueryParamType::Show, 1);
if ($response->object !== null) {
// handle response
@@ -1012,7 +1012,7 @@ actions:
try {
$response = $sdk->library->getMetadataChildren(1539.14, '<value>');
$response = $sdk->library->getMetadataChildren(1539.15, '<value>');
if ($response->object !== null) {
// handle response
@@ -1342,7 +1342,7 @@ actions:
try {
$response = $sdk->library->getSearchLibrary(9518, Operations\QueryParamType::Two);
$response = $sdk->library->getSearchLibrary(9518, Operations\QueryParamType::Show);
if ($response->object !== null) {
// handle response
@@ -1380,9 +1380,9 @@ actions:
$request = new Operations\GetLibraryItemsRequest(
sectionKey: 9518,
tag: Operations\Tag::Edition,
includeGuids: Operations\IncludeGuids::One,
includeMeta: Operations\IncludeMeta::One,
type: Operations\Type::Two,
includeGuids: Operations\IncludeGuids::Enable,
includeMeta: Operations\IncludeMeta::Enable,
type: Operations\Type::Show,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
);
@@ -1601,9 +1601,9 @@ actions:
width: 110,
height: 165,
opacity: 643869,
blur: 0,
minSize: Operations\MinSize::Zero,
upscale: Operations\Upscale::One,
blur: 4000,
minSize: Operations\MinSize::One,
upscale: Operations\Upscale::Zero,
url: '/library/metadata/49564/thumb/1654258204',
);
$response = $sdk->server->getResizedPhoto($request);
@@ -1667,7 +1667,7 @@ actions:
try {
$response = $sdk->plex->getTokenByPinId(408895, 'gcgzw5rz2xovp84b4vha3a40');
$response = $sdk->plex->getTokenByPinId(408895);
if ($response->authPinContainer !== null) {
// handle response
@@ -1742,7 +1742,7 @@ actions:
title: '<value>',
type: Operations\CreatePlaylistQueryParamType::Photo,
smart: Operations\Smart::One,
uri: 'https://inborn-brochure.biz',
uri: 'https://hoarse-testing.info/',
);
$response = $sdk->playlists->createPlaylist($request);
@@ -1780,7 +1780,7 @@ actions:
try {
$response = $sdk->playlists->uploadPlaylist('/home/barkley/playlist.m3u', Operations\QueryParamForce::Zero);
$response = $sdk->playlists->uploadPlaylist('/home/barkley/playlist.m3u', Operations\QueryParamForce::Zero, 1);
if ($response->statusCode === 200) {
// handle response
@@ -1885,7 +1885,7 @@ actions:
try {
$response = $sdk->playlists->updatePlaylist(3915, '<value>', '<value>');
$response = $sdk->playlists->updatePlaylist(3915.00, '<value>', '<value>');
if ($response->statusCode === 200) {
// handle response
@@ -1956,7 +1956,7 @@ actions:
try {
$response = $sdk->playlists->getPlaylistContents(5004.46, Operations\GetPlaylistContentsQueryParamType::Two);
$response = $sdk->playlists->getPlaylistContents(5004.46, Operations\GetPlaylistContentsQueryParamType::Show);
if ($response->object !== null) {
// handle response
@@ -1991,7 +1991,7 @@ actions:
try {
$response = $sdk->playlists->addPlaylistContents(8502.01, 'server://12345/com.plexapp.plugins.library/library/metadata/1', 123);
$response = $sdk->playlists->addPlaylistContents(8502.00, 'server://12345/com.plexapp.plugins.library/library/metadata/1', 123);
if ($response->object !== null) {
// handle response
@@ -2027,7 +2027,7 @@ actions:
try {
$response = $sdk->plex->getServerResources('gcgzw5rz2xovp84b4vha3a40', Operations\IncludeHttps::One, Operations\IncludeRelay::One, Operations\IncludeIPv6::One);
$response = $sdk->plex->getServerResources(Operations\IncludeHttps::Enable, Operations\IncludeRelay::Enable, Operations\IncludeIPv6::Enable);
if ($response->plexDevices !== null) {
// handle response
@@ -2097,7 +2097,7 @@ actions:
try {
$response = $sdk->authentication->getSourceConnectionInformation('server://client-identifier');
$response = $sdk->authentication->getSourceConnectionInformation('provider://provider-identifier');
if ($response->statusCode === 200) {
// handle response
@@ -2581,12 +2581,12 @@ actions:
->build();
try {
$requestBody = new Operations\PostUsersSignInDataRequestBody(
$request = new Operations\PostUsersSignInDataRequestBody(
login: 'username@email.com',
password: 'password123',
verificationCode: '123456',
);
$response = $sdk->authentication->postUsersSignInData('gcgzw5rz2xovp84b4vha3a40', $requestBody);
$response = $sdk->authentication->postUsersSignInData($request);
if ($response->userPlexAccount !== null) {
// handle response

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

@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

18
docs/Models/Operations/Connections.md
View File

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `protocol` | *string* | :heavy_check_mark: | N/A |
| `address` | *string* | :heavy_check_mark: | N/A |
| `port` | *float* | :heavy_check_mark: | N/A |
| `uri` | *string* | :heavy_check_mark: | N/A |
| `local` | *bool* | :heavy_check_mark: | N/A |
| `relay` | *bool* | :heavy_check_mark: | N/A |
| `iPv6` | *bool* | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `protocol` | [Operations\Protocol](../../Models/Operations/Protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
| `address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
| `port` | *int* | :heavy_check_mark: | The port used for the connection |
| `uri` | *string* | :heavy_check_mark: | The full URI of the connection |
| `local` | *bool* | :heavy_check_mark: | If the connection is local address |
| `relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct |
| `iPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 |

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

@@ -1,11 +1,11 @@
# DefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,24 +5,24 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | true |
| `art` | *?string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *?bool* | :heavy_minus_sign: | N/A | true |
| `refreshing` | *?bool* | :heavy_minus_sign: | N/A | false |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `key` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `agent` | *?string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
| `scanner` | *?string* | :heavy_minus_sign: | N/A | Plex Movie |
| `language` | *?string* | :heavy_minus_sign: | N/A | en-US |
| `uuid` | *?string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `createdAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `scannedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `content` | *?bool* | :heavy_minus_sign: | N/A | true |
| `directory` | *?bool* | :heavy_minus_sign: | N/A | true |
| `contentChangedAt` | *?int* | :heavy_minus_sign: | N/A | 3192854 |
| `hidden` | *?int* | :heavy_minus_sign: | N/A | 0 |
| `location` | array<[Operations\Location](../../Models/Operations/Location.md)> | :heavy_minus_sign: | N/A | |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | true |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *bool* | :heavy_check_mark: | N/A | true |
| `refreshing` | *bool* | :heavy_check_mark: | N/A | false |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
| `type` | *string* | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `updatedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `createdAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `scannedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *bool* | :heavy_check_mark: | N/A | true |
| `directory` | *bool* | :heavy_check_mark: | N/A | true |
| `contentChangedAt` | *int* | :heavy_check_mark: | N/A | 3192854 |
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
| `location` | array<[Operations\Location](../../Models/Operations/Location.md)> | :heavy_check_mark: | N/A | |

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

@@ -8,4 +8,4 @@
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
| `directory` | array<[Operations\GetAllLibrariesDirectory](../../Models/Operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
| `directory` | array<[Operations\GetAllLibrariesDirectory](../../Models/Operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |

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

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

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

@@ -0,0 +1,11 @@
# GetLibraryItemsField
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
| `type` | *string* | :heavy_check_mark: | N/A | string |
| `subType` | *?string* | :heavy_minus_sign: | N/A | rating |

9
docs/Models/Operations/GetLibraryItemsFieldType.md Normal file
View File

@@ -0,0 +1,9 @@
# GetLibraryItemsFieldType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `type` | *string* | :heavy_check_mark: | N/A | tag |
| `operator` | array<[Operations\GetLibraryItemsOperator](../../Models/Operations/GetLibraryItemsOperator.md)> | :heavy_check_mark: | N/A | |

12
docs/Models/Operations/GetLibraryItemsFilter.md Normal file
View File

@@ -0,0 +1,12 @@
# GetLibraryItemsFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
| `type` | *string* | :heavy_check_mark: | N/A | filter |

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

@@ -5,19 +5,20 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `size` | *?int* | :heavy_minus_sign: | N/A | 70 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | true |
| `art` | *?string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | [int\|string\|null](../../Models/Operations/LibrarySectionID.md) | :heavy_minus_sign: | N/A | |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?int* | :heavy_minus_sign: | N/A | 1701731894 |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `title1` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `title2` | *?string* | :heavy_minus_sign: | N/A | Recently Released |
| `viewGroup` | *?string* | :heavy_minus_sign: | N/A | movie |
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
| `allowSync` | *bool* | :heavy_check_mark: | N/A | true |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `librarySectionID` | [int\|string](../../Models/Operations/LibrarySectionID.md) | :heavy_check_mark: | N/A | |
| `librarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
| `librarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `title1` | *string* | :heavy_check_mark: | N/A | Movies |
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
| `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | true |
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
| `meta` | [?Operations\Meta](../../Models/Operations/Meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

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

@@ -5,21 +5,22 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *?string* | :heavy_minus_sign: | N/A | 58683 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `ratingKey` | *string* | :heavy_check_mark: | N/A | 58683 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | *string* | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `year` | *int* | :heavy_check_mark: | N/A | 2022 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `media` | array<[Operations\GetLibraryItemsMedia](../../Models/Operations/GetLibraryItemsMedia.md)> | :heavy_check_mark: | N/A | |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
| `addedAt` | *?int* | :heavy_minus_sign: | N/A | 1680457607 |
| `updatedAt` | *?int* | :heavy_minus_sign: | N/A | 1703239236 |
@@ -34,12 +35,12 @@
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
| `media` | array<[Operations\GetLibraryItemsMedia](../../Models/Operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\GetLibraryItemsGenre](../../Models/Operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\GetLibraryItemsCountry](../../Models/Operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\GetLibraryItemsDirector](../../Models/Operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\GetLibraryItemsWriter](../../Models/Operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetLibraryItemsRole](../../Models/Operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
| `mediaGuid` | array<[Operations\MediaGuid](../../Models/Operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | N/A | 1682752242 |

9
docs/Models/Operations/GetLibraryItemsOperator.md Normal file
View File

@@ -0,0 +1,9 @@
# GetLibraryItemsOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_check_mark: | N/A | = |
| `title` | *string* | :heavy_check_mark: | N/A | is |

13
docs/Models/Operations/GetLibraryItemsSort.md Normal file
View File

@@ -0,0 +1,13 @@
# GetLibraryItemsSort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `defaultDirection` | *string* | :heavy_check_mark: | N/A | asc |
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `title` | *string* | :heavy_check_mark: | N/A | Title |
| `default` | *?string* | :heavy_minus_sign: | N/A | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |

14
docs/Models/Operations/GetLibraryItemsType.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryItemsType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `type` | *string* | :heavy_check_mark: | N/A | show |
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `active` | *bool* | :heavy_check_mark: | N/A | false |
| `filter` | array<[Operations\GetLibraryItemsFilter](../../Models/Operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetLibraryItemsSort](../../Models/Operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetLibraryItemsField](../../Models/Operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |

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

@@ -3,11 +3,10 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *?bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientID` | *?string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `clientName` | *?string* | :heavy_minus_sign: | N/A | Plex Web |
| `deviceName` | *?string* | :heavy_minus_sign: | N/A | Linux |
| `clientVersion` | *?string* | :heavy_minus_sign: | N/A | 4.133.0 |
| `clientPlatform` | *?string* | :heavy_minus_sign: | N/A | Chrome |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *?bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `clientName` | *?string* | :heavy_minus_sign: | N/A | Plex Web |
| `deviceName` | *?string* | :heavy_minus_sign: | N/A | Linux |
| `clientVersion` | *?string* | :heavy_minus_sign: | N/A | 4.133.0 |
| `clientPlatform` | *?string* | :heavy_minus_sign: | N/A | Chrome |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -3,9 +3,8 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *?string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `includeHttps` | [?Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [?Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [?Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

7
docs/Models/Operations/GetTokenByPinIdRequest.md
View File

@@ -3,7 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pinID` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `clientID` | *?string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `pinID` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for |

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

@@ -22,13 +22,13 @@ Logged in user details
| `homeAdmin` | *bool* | :heavy_check_mark: | If the account is the Plex Home admin | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `mailingListActive` | *bool* | :heavy_check_mark: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [Operations\MailingListStatus](../../Models/Operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [Operations\UserProfile](../../Models/Operations/UserProfile.md) | :heavy_check_mark: | N/A | |
| `protected` | *bool* | :heavy_check_mark: | If the account has a Plex Home PIN enabled | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *bool* | :heavy_check_mark: | If the account is a Plex Home managed user | |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\Services](../../Models/Operations/Services.md)> | :heavy_check_mark: | N/A | |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -6,7 +6,7 @@ Adds the Guids object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ Include Https entries in the results
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ Include IPv6 entries in the results
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -6,7 +6,7 @@ Adds the Meta object to the response
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -7,7 +7,7 @@ E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `path` | *?string* | :heavy_minus_sign: | N/A | /movies |
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
| `path` | *string* | :heavy_check_mark: | N/A | /movies |

8
docs/Models/Operations/MediaGuid.md Normal file
View File

@@ -0,0 +1,8 @@
# MediaGuid
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

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

@@ -1,9 +1,11 @@
# MediaReviewsVisibility
Whether or not the account has media reviews visibility enabled
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

12
docs/Models/Operations/Meta.md Normal file
View File

@@ -0,0 +1,12 @@
# Meta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `type` | array<[Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A |
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |

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

@@ -3,29 +3,29 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `name` | *string* | :heavy_check_mark: | N/A |
| `product` | *string* | :heavy_check_mark: | N/A |
| `productVersion` | *string* | :heavy_check_mark: | N/A |
| `clientIdentifier` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A |
| `lastSeenAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A |
| `provides` | *string* | :heavy_check_mark: | N/A |
| `publicAddress` | *string* | :heavy_check_mark: | N/A |
| `accessToken` | *string* | :heavy_check_mark: | N/A |
| `owned` | *bool* | :heavy_check_mark: | N/A |
| `home` | *bool* | :heavy_check_mark: | N/A |
| `synced` | *bool* | :heavy_check_mark: | N/A |
| `relay` | *bool* | :heavy_check_mark: | N/A |
| `presence` | *bool* | :heavy_check_mark: | N/A |
| `httpsRequired` | *bool* | :heavy_check_mark: | N/A |
| `publicAddressMatches` | *bool* | :heavy_check_mark: | N/A |
| `dnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A |
| `natLoopbackSupported` | *bool* | :heavy_check_mark: | N/A |
| `connections` | array<[Operations\Connections](../../Models/Operations/Connections.md)> | :heavy_check_mark: | N/A |
| `platform` | *string* | :heavy_check_mark: | N/A |
| `platformVersion` | *string* | :heavy_check_mark: | N/A |
| `device` | *string* | :heavy_check_mark: | N/A |
| `ownerId` | *int* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request |
| `sourceTitle` | *string* | :heavy_check_mark: | N/A |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `name` | *string* | :heavy_check_mark: | N/A | |
| `product` | *string* | :heavy_check_mark: | N/A | |
| `productVersion` | *string* | :heavy_check_mark: | N/A | |
| `clientIdentifier` | *string* | :heavy_check_mark: | N/A | |
| `createdAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `lastSeenAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
| `provides` | *string* | :heavy_check_mark: | N/A | |
| `publicAddress` | *string* | :heavy_check_mark: | N/A | |
| `accessToken` | *string* | :heavy_check_mark: | N/A | |
| `owned` | *bool* | :heavy_check_mark: | N/A | |
| `home` | *bool* | :heavy_check_mark: | N/A | |
| `synced` | *bool* | :heavy_check_mark: | N/A | |
| `relay` | *bool* | :heavy_check_mark: | N/A | |
| `presence` | *bool* | :heavy_check_mark: | N/A | |
| `httpsRequired` | *bool* | :heavy_check_mark: | N/A | |
| `publicAddressMatches` | *bool* | :heavy_check_mark: | N/A | |
| `dnsRebindingProtection` | *bool* | :heavy_check_mark: | N/A | |
| `natLoopbackSupported` | *bool* | :heavy_check_mark: | N/A | |
| `connections` | array<[Operations\Connections](../../Models/Operations/Connections.md)> | :heavy_check_mark: | N/A | |
| `platform` | *string* | :heavy_check_mark: | N/A | |
| `platformVersion` | *string* | :heavy_check_mark: | N/A | |
| `device` | *string* | :heavy_check_mark: | N/A | |
| `ownerId` | *int* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
| `sourceTitle` | *string* | :heavy_check_mark: | N/A | |

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

@@ -5,7 +5,7 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -1,11 +1,11 @@
# PostUsersSignInDataDefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -5,7 +5,7 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -1,9 +1,11 @@
# PostUsersSignInDataMediaReviewsVisibility
Whether or not the account has media reviews visibility enabled
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

9
docs/Models/Operations/PostUsersSignInDataRequest.md
View File

@@ -1,9 +0,0 @@
# PostUsersSignInDataRequest
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *?string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `requestBody` | [?Operations\PostUsersSignInDataRequestBody](../../Models/Operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -22,13 +22,13 @@ Returns the user account data with a valid auth token
| `homeAdmin` | *bool* | :heavy_check_mark: | If the account is the Plex Home admin | |
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `mailingListActive` | *bool* | :heavy_check_mark: | If you are subscribed to the Plex newsletter | |
| `mailingListStatus` | [Operations\PostUsersSignInDataMailingListStatus](../../Models/Operations/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [Operations\PostUsersSignInDataUserProfile](../../Models/Operations/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `protected` | *bool* | :heavy_check_mark: | If the account has a Plex Home PIN enabled | |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `restricted` | *bool* | :heavy_check_mark: | If the account is a Plex Home managed user | |
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `services` | array<[Operations\PostUsersSignInDataServices](../../Models/Operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |

20
docs/Models/Operations/PostUsersSignInDataUserProfile.md
View File

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *?bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [?Operations\PostUsersSignInDataAutoSelectSubtitle](../../Models/Operations/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `defaultSubtitleAccessibility` | [?Operations\PostUsersSignInDataDefaultSubtitleAccessibility](../../Models/Operations/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `defaultSubtitleForced` | [?Operations\PostUsersSignInDataDefaultSubtitleForced](../../Models/Operations/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `watchedIndicator` | [?Operations\PostUsersSignInDataWatchedIndicator](../../Models/Operations/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [?Operations\PostUsersSignInDataMediaReviewsVisibility](../../Models/Operations/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *bool* | :heavy_check_mark: | If the account has automatically select audio and subtitle tracks enabled | true |
| `autoSelectSubtitle` | [Operations\PostUsersSignInDataAutoSelectSubtitle](../../Models/Operations/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_check_mark: | N/A | 1 |
| `defaultSubtitleAccessibility` | [Operations\PostUsersSignInDataDefaultSubtitleAccessibility](../../Models/Operations/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_check_mark: | N/A | 1 |
| `defaultSubtitleForced` | [Operations\PostUsersSignInDataDefaultSubtitleForced](../../Models/Operations/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_check_mark: | N/A | 1 |
| `watchedIndicator` | [Operations\PostUsersSignInDataWatchedIndicator](../../Models/Operations/PostUsersSignInDataWatchedIndicator.md) | :heavy_check_mark: | N/A | 1 |
| `mediaReviewsVisibility` | [Operations\PostUsersSignInDataMediaReviewsVisibility](../../Models/Operations/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_check_mark: | N/A | 1 |
| `defaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |

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

@@ -1,9 +1,11 @@
# PostUsersSignInDataWatchedIndicator
Whether or not media watched indicators are enabled (little orange dot on media)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -0,0 +1,11 @@
# Protocol
The protocol used for the connection (http, https, etc)
## Values
| Name | Value |
| ------- | ------- |
| `Http` | http |
| `Https` | https |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -11,9 +11,9 @@ E.g. A movie library will not return anything with type 3 as there are no season
## Values
| Name | Value |
| ------- | ------- |
| `One` | 1 |
| `Two` | 2 |
| `Three` | 3 |
| `Four` | 4 |
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `Show` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

3
docs/Models/Operations/UploadPlaylistRequest.md
View File

@@ -6,4 +6,5 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `force` | [Operations\QueryParamForce](../../Models/Operations/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `force` | [Operations\QueryParamForce](../../Models/Operations/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `sectionID` | *int* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |

20
docs/Models/Operations/UserProfile.md
View File

@@ -3,13 +3,13 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *?bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `defaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `autoSelectSubtitle` | [?Operations\AutoSelectSubtitle](../../Models/Operations/AutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `defaultSubtitleAccessibility` | [?Operations\DefaultSubtitleAccessibility](../../Models/Operations/DefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `defaultSubtitleForced` | [?Operations\DefaultSubtitleForced](../../Models/Operations/DefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `watchedIndicator` | [?Operations\WatchedIndicator](../../Models/Operations/WatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `mediaReviewsVisibility` | [?Operations\MediaReviewsVisibility](../../Models/Operations/MediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `autoSelectAudio` | *bool* | :heavy_check_mark: | If the account has automatically select audio and subtitle tracks enabled | true |
| `autoSelectSubtitle` | [Operations\AutoSelectSubtitle](../../Models/Operations/AutoSelectSubtitle.md) | :heavy_check_mark: | N/A | 1 |
| `defaultSubtitleAccessibility` | [Operations\DefaultSubtitleAccessibility](../../Models/Operations/DefaultSubtitleAccessibility.md) | :heavy_check_mark: | N/A | 1 |
| `defaultSubtitleForced` | [Operations\DefaultSubtitleForced](../../Models/Operations/DefaultSubtitleForced.md) | :heavy_check_mark: | N/A | 1 |
| `watchedIndicator` | [Operations\WatchedIndicator](../../Models/Operations/WatchedIndicator.md) | :heavy_check_mark: | N/A | 1 |
| `mediaReviewsVisibility` | [Operations\MediaReviewsVisibility](../../Models/Operations/MediaReviewsVisibility.md) | :heavy_check_mark: | N/A | 1 |
| `defaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `defaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |

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

@@ -1,9 +1,11 @@
# WatchedIndicator
Whether or not media watched indicators are enabled (little orange dot on media)
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -102,7 +102,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->authentication->getSourceConnectionInformation('server://client-identifier');
$response = $sdk->authentication->getSourceConnectionInformation('provider://provider-identifier');
if ($response->statusCode === 200) {
// handle response
@@ -210,12 +210,12 @@ $sdk = Plex_API\PlexAPI::builder()
->build();
try {
$requestBody = new Operations\PostUsersSignInDataRequestBody(
$request = new Operations\PostUsersSignInDataRequestBody(
login: 'username@email.com',
password: 'password123',
verificationCode: '123456',
);
$response = $sdk->authentication->postUsersSignInData('gcgzw5rz2xovp84b4vha3a40', $requestBody);
$response = $sdk->authentication->postUsersSignInData($request);
if ($response->userPlexAccount !== null) {
// handle response
@@ -227,11 +227,10 @@ try {
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `requestBody` | [Operations\PostUsersSignInDataRequestBody](../../Models/Operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `$request` | [Operations\PostUsersSignInDataRequestBody](../../Models/Operations/PostUsersSignInDataRequestBody.md) | :heavy_check_mark: | The request object to use for the request. |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response

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

@@ -99,7 +99,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->hubs->getLibraryHubs(6728.76, 9010.22, Operations\QueryParamOnlyTransient::Zero);
$response = $sdk->hubs->getLibraryHubs(6728.76, 639.24, Operations\QueryParamOnlyTransient::One);
if ($response->object !== null) {
// handle response

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

@@ -399,9 +399,9 @@ try {
$request = new Operations\GetLibraryItemsRequest(
sectionKey: 9518,
tag: Operations\Tag::Edition,
type: Operations\Type::Two,
includeGuids: Operations\IncludeGuids::One,
includeMeta: Operations\IncludeMeta::One,
type: Operations\Type::Show,
includeGuids: Operations\IncludeGuids::Enable,
includeMeta: Operations\IncludeMeta::Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
);
@@ -541,7 +541,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->library->getSearchLibrary(9518, Operations\QueryParamType::Two);
$response = $sdk->library->getSearchLibrary(9518, Operations\QueryParamType::Show);
if ($response->object !== null) {
// handle response
@@ -658,7 +658,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->library->getMetadataChildren(1539.14, '<value>');
$response = $sdk->library->getMetadataChildren(1539.15, '<value>');
if ($response->object !== null) {
// handle response
@@ -718,7 +718,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->library->getTopWatchedContent(Operations\GetTopWatchedContentQueryParamType::Two, 1);
$response = $sdk->library->getTopWatchedContent(Operations\GetTopWatchedContentQueryParamType::Show, 1);
if ($response->object !== null) {
// handle response

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

@@ -55,7 +55,7 @@ try {
title: '<value>',
type: Operations\CreatePlaylistQueryParamType::Photo,
smart: Operations\Smart::One,
uri: 'https://inborn-brochure.biz',
uri: 'https://hoarse-testing.info/',
);
$response = $sdk->playlists->createPlaylist($request);
@@ -291,7 +291,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->playlists->updatePlaylist(3915, '<value>', '<value>');
$response = $sdk->playlists->updatePlaylist(3915.00, '<value>', '<value>');
if ($response->statusCode === 200) {
// handle response
@@ -355,7 +355,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->playlists->getPlaylistContents(5004.46, Operations\GetPlaylistContentsQueryParamType::Two);
$response = $sdk->playlists->getPlaylistContents(5004.46, Operations\GetPlaylistContentsQueryParamType::Show);
if ($response->object !== null) {
// handle response
@@ -473,7 +473,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->playlists->addPlaylistContents(8502.01, 'server://12345/com.plexapp.plugins.library/library/metadata/1', 123);
$response = $sdk->playlists->addPlaylistContents(8502.00, 'server://12345/com.plexapp.plugins.library/library/metadata/1', 123);
if ($response->object !== null) {
// handle response
@@ -534,7 +534,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->playlists->uploadPlaylist('/home/barkley/playlist.m3u', Operations\QueryParamForce::Zero);
$response = $sdk->playlists->uploadPlaylist('/home/barkley/playlist.m3u', Operations\QueryParamForce::Zero, 1);
if ($response->statusCode === 200) {
// handle response
@@ -550,6 +550,7 @@ try {
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `force` | [Operations\QueryParamForce](../../Models/Operations/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `sectionID` | *int* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
### Response

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

@@ -257,7 +257,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->plex->getServerResources('gcgzw5rz2xovp84b4vha3a40', Operations\IncludeHttps::One, Operations\IncludeRelay::One, Operations\IncludeIPv6::One);
$response = $sdk->plex->getServerResources(Operations\IncludeHttps::Enable, Operations\IncludeRelay::Enable, Operations\IncludeIPv6::Enable);
if ($response->plexDevices !== null) {
// handle response
@@ -269,13 +269,12 @@ try {
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `includeHttps` | [Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `includeHttps` | [Operations\IncludeHttps](../../Models/Operations/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [Operations\IncludeRelay](../../Models/Operations/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [Operations\IncludeIPv6](../../Models/Operations/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
@@ -366,7 +365,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->plex->getTokenByPinId(408895, 'gcgzw5rz2xovp84b4vha3a40');
$response = $sdk->plex->getTokenByPinId(408895);
if ($response->authPinContainer !== null) {
// handle response
@@ -378,11 +377,10 @@ try {
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pinID` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `clientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `pinID` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `$serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response

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

@@ -51,7 +51,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->search->performSearch('arnold', 9372.7, 5);
$response = $sdk->search->performSearch('dylan', 5838.67, 5);
if ($response->statusCode === 200) {
// handle response
@@ -114,7 +114,7 @@ $sdk = Plex_API\PlexAPI::builder()
try {
$response = $sdk->search->performVoiceSearch('dead+poop', 4094.8, 5);
$response = $sdk->search->performVoiceSearch('dead+poop', 4094.80, 5);
if ($response->statusCode === 200) {
// handle response

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

@@ -344,9 +344,9 @@ try {
width: 110,
height: 165,
opacity: 643869,
blur: 0,
minSize: Operations\MinSize::Zero,
upscale: Operations\Upscale::One,
blur: 4000,
minSize: Operations\MinSize::One,
upscale: Operations\Upscale::Zero,
url: '/library/metadata/49564/thumb/1654258204',
);
$response = $sdk->server->getResizedPhoto($request);

13
src/Authentication.php
View File

@@ -226,21 +226,15 @@ class Authentication
*
* Sign in user with username and password and return user data with Plex authentication token
*
* @param ?string $clientID
* @param ?Operations\PostUsersSignInDataRequestBody $requestBody
* @param Operations\PostUsersSignInDataRequestBody $request
* @param string $serverURL
* @return Operations\PostUsersSignInDataResponse
* @throws \LukeHagar\Plex_API\Models\Errors\SDKException
*/
public function postUsersSignInData(
?string $clientID = null,
?Operations\PostUsersSignInDataRequestBody $requestBody = null,
?Operations\PostUsersSignInDataRequestBody $request,
?string $serverURL = null,
): Operations\PostUsersSignInDataResponse {
$request = new Operations\PostUsersSignInDataRequest(
clientID: $clientID,
requestBody: $requestBody,
);
$baseUrl = Utils\Utils::templateUrl(Authentication::POST_USERS_SIGN_IN_DATA_SERVERS[0], [
]);
if (! empty($serverURL)) {
@@ -248,11 +242,10 @@ class Authentication
}
$url = Utils\Utils::generateUrl($baseUrl, '/users/signin');
$options = ['http_errors' => false];
$body = Utils\Utils::serializeRequestBody($request, 'requestBody', 'form');
$body = Utils\Utils::serializeRequestBody($request, 'request', 'form');
if ($body !== null) {
$options = array_merge_recursive($options, $body);
}
$options = array_merge_recursive($options, Utils\Utils::getQueryParams(Operations\PostUsersSignInDataRequest::class, $request, $this->sdkConfiguration->globals));
$options['headers']['Accept'] = 'application/json';
$options['headers']['user-agent'] = $this->sdkConfiguration->userAgent;
$httpRequest = new \GuzzleHttp\Psr7\Request('POST', $url);

2
src/Models/Components/Security.php
View File

@@ -15,7 +15,7 @@ class Security
*
* @var ?string $accessToken
*/
#[SpeakeasyMetadata('security:scheme=true,type=apiKey,subtype=query,name=X-Plex-Token')]
#[SpeakeasyMetadata('security:scheme=true,type=apiKey,subtype=header,name=X-Plex-Token')]
public ?string $accessToken = null;
/**

6
src/Models/Operations/AutoSelectSubtitle.php
View File

@@ -10,8 +10,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) */
enum AutoSelectSubtitle: string
enum AutoSelectSubtitle: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

22
src/Models/Operations/Connections.php
View File

@@ -12,13 +12,16 @@ namespace LukeHagar\Plex_API\Models\Operations;
class Connections
{
/**
* The protocol used for the connection (http, https, etc)
*
* @var string $protocol
* @var Protocol $protocol
*/
#[\JMS\Serializer\Annotation\SerializedName('protocol')]
public string $protocol;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\Protocol')]
public Protocol $protocol;
/**
* The (ip) address or domain name used for the connection
*
* @var string $address
*/
@@ -26,13 +29,15 @@ class Connections
public string $address;
/**
* The port used for the connection
*
* @var float $port
* @var int $port
*/
#[\JMS\Serializer\Annotation\SerializedName('port')]
public float $port;
public int $port;
/**
* The full URI of the connection
*
* @var string $uri
*/
@@ -40,6 +45,7 @@ class Connections
public string $uri;
/**
* If the connection is local address
*
* @var bool $local
*/
@@ -47,6 +53,7 @@ class Connections
public bool $local;
/**
* If the connection is relayed through plex.direct
*
* @var bool $relay
*/
@@ -54,6 +61,7 @@ class Connections
public bool $relay;
/**
* If the connection is using IPv6
*
* @var bool $iPv6
*/
@@ -61,15 +69,15 @@ class Connections
public bool $iPv6;
/**
* @param string $protocol
* @param Protocol $protocol
* @param string $address
* @param float $port
* @param int $port
* @param string $uri
* @param bool $local
* @param bool $relay
* @param bool $iPv6
*/
public function __construct(string $protocol, string $address, float $port, string $uri, bool $local, bool $relay, bool $iPv6)
public function __construct(Protocol $protocol, string $address, int $port, string $uri, bool $local, bool $relay, bool $iPv6)
{
$this->protocol = $protocol;
$this->address = $address;

8
src/Models/Operations/DefaultSubtitleAccessibility.php
View File

@@ -9,9 +9,9 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) */
enum DefaultSubtitleAccessibility: string
/** The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles) */
enum DefaultSubtitleAccessibility: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

6
src/Models/Operations/DefaultSubtitleForced.php
View File

@@ -10,8 +10,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) */
enum DefaultSubtitleForced: string
enum DefaultSubtitleForced: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

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

@@ -13,201 +13,180 @@ class GetAllLibrariesDirectory
{
/**
*
* @var ?bool $allowSync
* @var bool $allowSync
*/
#[\JMS\Serializer\Annotation\SerializedName('allowSync')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $allowSync = null;
public bool $allowSync;
/**
*
* @var ?string $art
* @var string $art
*/
#[\JMS\Serializer\Annotation\SerializedName('art')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $art = null;
public string $art;
/**
*
* @var ?string $composite
* @var string $composite
*/
#[\JMS\Serializer\Annotation\SerializedName('composite')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $composite = null;
public string $composite;
/**
*
* @var ?bool $filters
* @var bool $filters
*/
#[\JMS\Serializer\Annotation\SerializedName('filters')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $filters = null;
public bool $filters;
/**
*
* @var ?bool $refreshing
* @var bool $refreshing
*/
#[\JMS\Serializer\Annotation\SerializedName('refreshing')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $refreshing = null;
public bool $refreshing;
/**
*
* @var ?string $thumb
* @var string $thumb
*/
#[\JMS\Serializer\Annotation\SerializedName('thumb')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $thumb = null;
public string $thumb;
/**
*
* @var ?string $key
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $key = null;
public string $key;
/**
*
* @var ?string $type
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $type = null;
public string $type;
/**
*
* @var ?string $title
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $title = null;
public string $title;
/**
*
* @var ?string $agent
* @var string $agent
*/
#[\JMS\Serializer\Annotation\SerializedName('agent')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $agent = null;
public string $agent;
/**
*
* @var ?string $scanner
* @var string $scanner
*/
#[\JMS\Serializer\Annotation\SerializedName('scanner')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $scanner = null;
public string $scanner;
/**
*
* @var ?string $language
* @var string $language
*/
#[\JMS\Serializer\Annotation\SerializedName('language')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $language = null;
public string $language;
/**
*
* @var ?string $uuid
* @var string $uuid
*/
#[\JMS\Serializer\Annotation\SerializedName('uuid')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $uuid = null;
public string $uuid;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var ?int $updatedAt
* @var int $updatedAt
*/
#[\JMS\Serializer\Annotation\SerializedName('updatedAt')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $updatedAt = null;
public int $updatedAt;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var ?int $createdAt
* @var int $createdAt
*/
#[\JMS\Serializer\Annotation\SerializedName('createdAt')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $createdAt = null;
public int $createdAt;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var ?int $scannedAt
* @var int $scannedAt
*/
#[\JMS\Serializer\Annotation\SerializedName('scannedAt')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $scannedAt = null;
public int $scannedAt;
/**
*
* @var ?bool $content
* @var bool $content
*/
#[\JMS\Serializer\Annotation\SerializedName('content')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $content = null;
public bool $content;
/**
*
* @var ?bool $directory
* @var bool $directory
*/
#[\JMS\Serializer\Annotation\SerializedName('directory')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $directory = null;
public bool $directory;
/**
*
* @var ?int $contentChangedAt
* @var int $contentChangedAt
*/
#[\JMS\Serializer\Annotation\SerializedName('contentChangedAt')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $contentChangedAt = null;
public int $contentChangedAt;
/**
*
* @var ?int $hidden
* @var int $hidden
*/
#[\JMS\Serializer\Annotation\SerializedName('hidden')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $hidden = null;
public int $hidden;
/**
* $location
*
* @var ?array<Location> $location
* @var array<Location> $location
*/
#[\JMS\Serializer\Annotation\SerializedName('Location')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\Location>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $location = null;
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\Location>')]
public array $location;
/**
* @param ?bool $allowSync
* @param ?string $art
* @param ?string $composite
* @param ?bool $filters
* @param ?bool $refreshing
* @param ?string $thumb
* @param ?string $key
* @param ?string $type
* @param ?string $title
* @param ?string $agent
* @param ?string $scanner
* @param ?string $language
* @param ?string $uuid
* @param ?int $updatedAt
* @param ?int $createdAt
* @param ?int $scannedAt
* @param ?bool $content
* @param ?bool $directory
* @param ?int $contentChangedAt
* @param ?int $hidden
* @param ?array<Location> $location
* @param bool $allowSync
* @param string $art
* @param string $composite
* @param bool $filters
* @param bool $refreshing
* @param string $thumb
* @param string $key
* @param string $type
* @param string $title
* @param string $agent
* @param string $scanner
* @param string $language
* @param string $uuid
* @param int $updatedAt
* @param int $createdAt
* @param int $scannedAt
* @param bool $content
* @param bool $directory
* @param int $contentChangedAt
* @param int $hidden
* @param array<Location> $location
*/
public function __construct(?bool $allowSync = null, ?string $art = null, ?string $composite = null, ?bool $filters = null, ?bool $refreshing = null, ?string $thumb = null, ?string $key = null, ?string $type = null, ?string $title = null, ?string $agent = null, ?string $scanner = null, ?string $language = null, ?string $uuid = null, ?int $updatedAt = null, ?int $createdAt = null, ?int $scannedAt = null, ?bool $content = null, ?bool $directory = null, ?int $contentChangedAt = null, ?int $hidden = null, ?array $location = null)
public function __construct(bool $allowSync, string $art, string $composite, bool $filters, bool $refreshing, string $thumb, string $key, string $type, string $title, string $agent, string $scanner, string $language, string $uuid, int $updatedAt, int $createdAt, int $scannedAt, bool $content, bool $directory, int $contentChangedAt, int $hidden, array $location)
{
$this->allowSync = $allowSync;
$this->art = $art;

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

@@ -35,20 +35,19 @@ class GetAllLibrariesMediaContainer
/**
* $directory
*
* @var ?array<GetAllLibrariesDirectory> $directory
* @var array<GetAllLibrariesDirectory> $directory
*/
#[\JMS\Serializer\Annotation\SerializedName('Directory')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesDirectory>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $directory = null;
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetAllLibrariesDirectory>')]
public array $directory;
/**
* @param int $size
* @param bool $allowSync
* @param string $title1
* @param ?array<GetAllLibrariesDirectory> $directory
* @param array<GetAllLibrariesDirectory> $directory
*/
public function __construct(int $size, bool $allowSync, string $title1, ?array $directory = null)
public function __construct(int $size, bool $allowSync, string $title1, array $directory)
{
$this->size = $size;
$this->allowSync = $allowSync;

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

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

56
src/Models/Operations/GetLibraryItemsField.php Normal file
View File

@@ -0,0 +1,56 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsField
{
/**
*
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
*
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
*
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
public string $type;
/**
*
* @var ?string $subType
*/
#[\JMS\Serializer\Annotation\SerializedName('subType')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $subType = null;
/**
* @param string $key
* @param string $title
* @param string $type
* @param ?string $subType
*/
public function __construct(string $key, string $title, string $type, ?string $subType = null)
{
$this->key = $key;
$this->title = $title;
$this->type = $type;
$this->subType = $subType;
}
}

39
src/Models/Operations/GetLibraryItemsFieldType.php Normal file
View File

@@ -0,0 +1,39 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsFieldType
{
/**
*
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
public string $type;
/**
* $operator
*
* @var array<GetLibraryItemsOperator> $operator
*/
#[\JMS\Serializer\Annotation\SerializedName('Operator')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsOperator>')]
public array $operator;
/**
* @param string $type
* @param array<GetLibraryItemsOperator> $operator
*/
public function __construct(string $type, array $operator)
{
$this->type = $type;
$this->operator = $operator;
}
}

64
src/Models/Operations/GetLibraryItemsFilter.php Normal file
View File

@@ -0,0 +1,64 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsFilter
{
/**
*
* @var string $filter
*/
#[\JMS\Serializer\Annotation\SerializedName('filter')]
public string $filter;
/**
*
* @var string $filterType
*/
#[\JMS\Serializer\Annotation\SerializedName('filterType')]
public string $filterType;
/**
*
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
*
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
*
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
public string $type;
/**
* @param string $filter
* @param string $filterType
* @param string $key
* @param string $title
* @param string $type
*/
public function __construct(string $filter, string $filterType, string $key, string $title, string $type)
{
$this->filter = $filter;
$this->filterType = $filterType;
$this->key = $key;
$this->title = $title;
$this->type = $type;
}
}

107
src/Models/Operations/GetLibraryItemsMediaContainer.php
View File

@@ -13,108 +13,95 @@ class GetLibraryItemsMediaContainer
{
/**
*
* @var ?int $size
* @var int $size
*/
#[\JMS\Serializer\Annotation\SerializedName('size')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $size = null;
public int $size;
/**
*
* @var ?bool $allowSync
* @var bool $allowSync
*/
#[\JMS\Serializer\Annotation\SerializedName('allowSync')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $allowSync = null;
public bool $allowSync;
/**
*
* @var ?string $art
* @var string $art
*/
#[\JMS\Serializer\Annotation\SerializedName('art')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $art = null;
public string $art;
/**
*
* @var ?string $identifier
* @var string $identifier
*/
#[\JMS\Serializer\Annotation\SerializedName('identifier')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $identifier = null;
public string $identifier;
/**
*
* @var int|string|null $librarySectionID
* @var int|string $librarySectionID
*/
#[\JMS\Serializer\Annotation\SerializedName('librarySectionID')]
#[\JMS\Serializer\Annotation\Type('int|string')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public int|string|null $librarySectionID = null;
public int|string $librarySectionID;
/**
*
* @var ?string $librarySectionTitle
* @var string $librarySectionTitle
*/
#[\JMS\Serializer\Annotation\SerializedName('librarySectionTitle')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $librarySectionTitle = null;
public string $librarySectionTitle;
/**
*
* @var ?string $librarySectionUUID
* @var string $librarySectionUUID
*/
#[\JMS\Serializer\Annotation\SerializedName('librarySectionUUID')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $librarySectionUUID = null;
public string $librarySectionUUID;
/**
*
* @var ?string $mediaTagPrefix
* @var string $mediaTagPrefix
*/
#[\JMS\Serializer\Annotation\SerializedName('mediaTagPrefix')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $mediaTagPrefix = null;
public string $mediaTagPrefix;
/**
*
* @var ?int $mediaTagVersion
* @var int $mediaTagVersion
*/
#[\JMS\Serializer\Annotation\SerializedName('mediaTagVersion')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $mediaTagVersion = null;
public int $mediaTagVersion;
/**
*
* @var ?string $thumb
* @var string $thumb
*/
#[\JMS\Serializer\Annotation\SerializedName('thumb')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $thumb = null;
public string $thumb;
/**
*
* @var ?string $title1
* @var string $title1
*/
#[\JMS\Serializer\Annotation\SerializedName('title1')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $title1 = null;
public string $title1;
/**
*
* @var ?string $title2
* @var string $title2
*/
#[\JMS\Serializer\Annotation\SerializedName('title2')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $title2 = null;
public string $title2;
/**
*
* @var ?string $viewGroup
* @var string $viewGroup
*/
#[\JMS\Serializer\Annotation\SerializedName('viewGroup')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $viewGroup = null;
public string $viewGroup;
/**
*
@@ -143,24 +130,37 @@ class GetLibraryItemsMediaContainer
public ?array $metadata = null;
/**
* @param ?int $size
* @param ?bool $allowSync
* @param ?string $art
* @param ?string $identifier
* @param int|string|null $librarySectionID
* @param ?string $librarySectionTitle
* @param ?string $librarySectionUUID
* @param ?string $mediaTagPrefix
* @param ?int $mediaTagVersion
* @param ?string $thumb
* @param ?string $title1
* @param ?string $title2
* @param ?string $viewGroup
* The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
*
*
*
* @var ?Meta $meta
*/
#[\JMS\Serializer\Annotation\SerializedName('Meta')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\Meta|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?Meta $meta = null;
/**
* @param int $size
* @param bool $allowSync
* @param string $art
* @param string $identifier
* @param int|string $librarySectionID
* @param string $librarySectionTitle
* @param string $librarySectionUUID
* @param string $mediaTagPrefix
* @param int $mediaTagVersion
* @param string $thumb
* @param string $title1
* @param string $title2
* @param string $viewGroup
* @param ?int $viewMode
* @param ?bool $mixedParents
* @param ?array<GetLibraryItemsMetadata> $metadata
* @param ?Meta $meta
*/
public function __construct(?int $size = null, ?bool $allowSync = null, ?string $art = null, ?string $identifier = null, int|string|null $librarySectionID = null, ?string $librarySectionTitle = null, ?string $librarySectionUUID = null, ?string $mediaTagPrefix = null, ?int $mediaTagVersion = null, ?string $thumb = null, ?string $title1 = null, ?string $title2 = null, ?string $viewGroup = null, ?int $viewMode = null, ?bool $mixedParents = null, ?array $metadata = null)
public function __construct(int $size, bool $allowSync, string $art, string $identifier, int|string $librarySectionID, string $librarySectionTitle, string $librarySectionUUID, string $mediaTagPrefix, int $mediaTagVersion, string $thumb, string $title1, string $title2, string $viewGroup, ?int $viewMode = null, ?bool $mixedParents = null, ?array $metadata = null, ?Meta $meta = null)
{
$this->size = $size;
$this->allowSync = $allowSync;
@@ -178,5 +178,6 @@ class GetLibraryItemsMediaContainer
$this->viewMode = $viewMode;
$this->mixedParents = $mixedParents;
$this->metadata = $metadata;
$this->meta = $meta;
}
}

82
src/Models/Operations/GetLibraryItemsMetadata.php
View File

@@ -13,27 +13,24 @@ class GetLibraryItemsMetadata
{
/**
*
* @var ?string $ratingKey
* @var string $ratingKey
*/
#[\JMS\Serializer\Annotation\SerializedName('ratingKey')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $ratingKey = null;
public string $ratingKey;
/**
*
* @var ?string $key
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $key = null;
public string $key;
/**
*
* @var ?string $guid
* @var string $guid
*/
#[\JMS\Serializer\Annotation\SerializedName('guid')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $guid = null;
public string $guid;
/**
*
@@ -45,19 +42,17 @@ class GetLibraryItemsMetadata
/**
*
* @var ?string $type
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $type = null;
public string $type;
/**
*
* @var ?string $title
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $title = null;
public string $title;
/**
*
@@ -93,11 +88,10 @@ class GetLibraryItemsMetadata
/**
*
* @var ?int $year
* @var int $year
*/
#[\JMS\Serializer\Annotation\SerializedName('year')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $year = null;
public int $year;
/**
*
@@ -125,11 +119,10 @@ class GetLibraryItemsMetadata
/**
*
* @var ?int $duration
* @var int $duration
*/
#[\JMS\Serializer\Annotation\SerializedName('duration')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $duration = null;
public int $duration;
/**
*
@@ -246,12 +239,11 @@ class GetLibraryItemsMetadata
/**
* $media
*
* @var ?array<GetLibraryItemsMedia> $media
* @var array<GetLibraryItemsMedia> $media
*/
#[\JMS\Serializer\Annotation\SerializedName('Media')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsMedia>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $media = null;
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsMedia>')]
public array $media;
/**
* $genre
@@ -303,6 +295,18 @@ class GetLibraryItemsMetadata
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $role = null;
/**
* The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
*
*
*
* @var ?array<MediaGuid> $mediaGuid
*/
#[\JMS\Serializer\Annotation\SerializedName('Guid')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\MediaGuid>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $mediaGuid = null;
/**
*
* @var ?string $titleSort
@@ -480,21 +484,22 @@ class GetLibraryItemsMetadata
public ?string $parentTheme = null;
/**
* @param ?string $ratingKey
* @param ?string $key
* @param ?string $guid
* @param string $ratingKey
* @param string $key
* @param string $guid
* @param string $type
* @param string $title
* @param int $year
* @param int $duration
* @param array<GetLibraryItemsMedia> $media
* @param ?string $studio
* @param ?string $type
* @param ?string $title
* @param ?string $contentRating
* @param ?string $summary
* @param ?float $rating
* @param ?float $audienceRating
* @param ?int $year
* @param ?string $tagline
* @param ?string $thumb
* @param ?string $art
* @param ?int $duration
* @param ?LocalDate $originallyAvailableAt
* @param ?int $addedAt
* @param ?int $updatedAt
@@ -509,12 +514,12 @@ class GetLibraryItemsMetadata
* @param ?string $grandparentThumb
* @param ?string $grandparentArt
* @param ?string $grandparentTheme
* @param ?array<GetLibraryItemsMedia> $media
* @param ?array<GetLibraryItemsGenre> $genre
* @param ?array<GetLibraryItemsCountry> $country
* @param ?array<GetLibraryItemsDirector> $director
* @param ?array<GetLibraryItemsWriter> $writer
* @param ?array<GetLibraryItemsRole> $role
* @param ?array<MediaGuid> $mediaGuid
* @param ?string $titleSort
* @param ?int $viewCount
* @param ?int $lastViewedAt
@@ -538,23 +543,24 @@ class GetLibraryItemsMetadata
* @param ?string $parentThumb
* @param ?string $parentTheme
*/
public function __construct(?string $ratingKey = null, ?string $key = null, ?string $guid = null, ?string $studio = null, ?string $type = null, ?string $title = null, ?string $contentRating = null, ?string $summary = null, ?float $rating = null, ?float $audienceRating = null, ?int $year = null, ?string $tagline = null, ?string $thumb = null, ?string $art = null, ?int $duration = null, ?LocalDate $originallyAvailableAt = null, ?int $addedAt = null, ?int $updatedAt = null, ?string $audienceRatingImage = null, ?string $chapterSource = null, ?string $primaryExtraKey = null, ?string $ratingImage = null, ?string $grandparentRatingKey = null, ?string $grandparentGuid = null, ?string $grandparentKey = null, ?string $grandparentTitle = null, ?string $grandparentThumb = null, ?string $grandparentArt = null, ?string $grandparentTheme = null, ?array $media = null, ?array $genre = null, ?array $country = null, ?array $director = null, ?array $writer = null, ?array $role = null, ?string $titleSort = null, ?int $viewCount = null, ?int $lastViewedAt = null, ?string $originalTitle = null, ?int $viewOffset = null, ?int $skipCount = null, ?int $index = null, ?string $theme = null, ?int $leafCount = null, ?int $viewedLeafCount = null, ?int $childCount = null, ?string $hasPremiumExtras = null, ?string $hasPremiumPrimaryExtra = null, ?string $parentRatingKey = null, ?string $parentGuid = null, ?string $parentStudio = null, ?string $parentKey = null, ?string $parentTitle = null, ?int $parentIndex = null, ?int $parentYear = null, ?string $parentThumb = null, ?string $parentTheme = null)
public function __construct(string $ratingKey, string $key, string $guid, string $type, string $title, int $year, int $duration, array $media, ?string $studio = null, ?string $contentRating = null, ?string $summary = null, ?float $rating = null, ?float $audienceRating = null, ?string $tagline = null, ?string $thumb = null, ?string $art = null, ?LocalDate $originallyAvailableAt = null, ?int $addedAt = null, ?int $updatedAt = null, ?string $audienceRatingImage = null, ?string $chapterSource = null, ?string $primaryExtraKey = null, ?string $ratingImage = null, ?string $grandparentRatingKey = null, ?string $grandparentGuid = null, ?string $grandparentKey = null, ?string $grandparentTitle = null, ?string $grandparentThumb = null, ?string $grandparentArt = null, ?string $grandparentTheme = null, ?array $genre = null, ?array $country = null, ?array $director = null, ?array $writer = null, ?array $role = null, ?array $mediaGuid = null, ?string $titleSort = null, ?int $viewCount = null, ?int $lastViewedAt = null, ?string $originalTitle = null, ?int $viewOffset = null, ?int $skipCount = null, ?int $index = null, ?string $theme = null, ?int $leafCount = null, ?int $viewedLeafCount = null, ?int $childCount = null, ?string $hasPremiumExtras = null, ?string $hasPremiumPrimaryExtra = null, ?string $parentRatingKey = null, ?string $parentGuid = null, ?string $parentStudio = null, ?string $parentKey = null, ?string $parentTitle = null, ?int $parentIndex = null, ?int $parentYear = null, ?string $parentThumb = null, ?string $parentTheme = null)
{
$this->ratingKey = $ratingKey;
$this->key = $key;
$this->guid = $guid;
$this->studio = $studio;
$this->type = $type;
$this->title = $title;
$this->year = $year;
$this->duration = $duration;
$this->media = $media;
$this->studio = $studio;
$this->contentRating = $contentRating;
$this->summary = $summary;
$this->rating = $rating;
$this->audienceRating = $audienceRating;
$this->year = $year;
$this->tagline = $tagline;
$this->thumb = $thumb;
$this->art = $art;
$this->duration = $duration;
$this->originallyAvailableAt = $originallyAvailableAt;
$this->addedAt = $addedAt;
$this->updatedAt = $updatedAt;
@@ -569,12 +575,12 @@ class GetLibraryItemsMetadata
$this->grandparentThumb = $grandparentThumb;
$this->grandparentArt = $grandparentArt;
$this->grandparentTheme = $grandparentTheme;
$this->media = $media;
$this->genre = $genre;
$this->country = $country;
$this->director = $director;
$this->writer = $writer;
$this->role = $role;
$this->mediaGuid = $mediaGuid;
$this->titleSort = $titleSort;
$this->viewCount = $viewCount;
$this->lastViewedAt = $lastViewedAt;

37
src/Models/Operations/GetLibraryItemsOperator.php Normal file
View File

@@ -0,0 +1,37 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsOperator
{
/**
*
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
*
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
* @param string $key
* @param string $title
*/
public function __construct(string $key, string $title)
{
$this->key = $key;
$this->title = $title;
}
}

76
src/Models/Operations/GetLibraryItemsSort.php Normal file
View File

@@ -0,0 +1,76 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsSort
{
/**
*
* @var ?string $default
*/
#[\JMS\Serializer\Annotation\SerializedName('default')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $default = null;
/**
*
* @var string $defaultDirection
*/
#[\JMS\Serializer\Annotation\SerializedName('defaultDirection')]
public string $defaultDirection;
/**
*
* @var ?string $descKey
*/
#[\JMS\Serializer\Annotation\SerializedName('descKey')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $descKey = null;
/**
*
* @var ?string $firstCharacterKey
*/
#[\JMS\Serializer\Annotation\SerializedName('firstCharacterKey')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $firstCharacterKey = null;
/**
*
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
*
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
* @param string $defaultDirection
* @param string $key
* @param string $title
* @param ?string $default
* @param ?string $descKey
* @param ?string $firstCharacterKey
*/
public function __construct(string $defaultDirection, string $key, string $title, ?string $default = null, ?string $descKey = null, ?string $firstCharacterKey = null)
{
$this->defaultDirection = $defaultDirection;
$this->key = $key;
$this->title = $title;
$this->default = $default;
$this->descKey = $descKey;
$this->firstCharacterKey = $firstCharacterKey;
}
}

91
src/Models/Operations/GetLibraryItemsType.php Normal file
View File

@@ -0,0 +1,91 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class GetLibraryItemsType
{
/**
*
* @var string $key
*/
#[\JMS\Serializer\Annotation\SerializedName('key')]
public string $key;
/**
*
* @var string $type
*/
#[\JMS\Serializer\Annotation\SerializedName('type')]
public string $type;
/**
*
* @var string $title
*/
#[\JMS\Serializer\Annotation\SerializedName('title')]
public string $title;
/**
*
* @var bool $active
*/
#[\JMS\Serializer\Annotation\SerializedName('active')]
public bool $active;
/**
* $filter
*
* @var ?array<GetLibraryItemsFilter> $filter
*/
#[\JMS\Serializer\Annotation\SerializedName('Filter')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsFilter>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $filter = null;
/**
* $sort
*
* @var ?array<GetLibraryItemsSort> $sort
*/
#[\JMS\Serializer\Annotation\SerializedName('Sort')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsSort>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $sort = null;
/**
* $field
*
* @var ?array<GetLibraryItemsField> $field
*/
#[\JMS\Serializer\Annotation\SerializedName('Field')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsField>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $field = null;
/**
* @param string $key
* @param string $type
* @param string $title
* @param bool $active
* @param ?array<GetLibraryItemsFilter> $filter
* @param ?array<GetLibraryItemsSort> $sort
* @param ?array<GetLibraryItemsField> $field
*/
public function __construct(string $key, string $type, string $title, bool $active, ?array $filter = null, ?array $sort = null, ?array $field = null)
{
$this->key = $key;
$this->type = $type;
$this->title = $title;
$this->active = $active;
$this->filter = $filter;
$this->sort = $sort;
$this->field = $field;
}
}

16
src/Models/Operations/GetPinRequest.php
View File

@@ -23,18 +23,6 @@ class GetPinRequest
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=strong')]
public ?bool $strong = null;
/**
* 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)
*
*
* @var ?string $clientID
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=X-Plex-Client-Identifier')]
public ?string $clientID = null;
/**
*
* @var ?string $clientName
@@ -65,16 +53,14 @@ class GetPinRequest
/**
* @param ?bool $strong
* @param ?string $clientID
* @param ?string $clientName
* @param ?string $deviceName
* @param ?string $clientVersion
* @param ?string $clientPlatform
*/
public function __construct(?bool $strong = null, ?string $clientID = null, ?string $clientName = null, ?string $deviceName = null, ?string $clientVersion = null, ?string $clientPlatform = null)
public function __construct(?bool $strong = null, ?string $clientName = null, ?string $deviceName = null, ?string $clientVersion = null, ?string $clientPlatform = null)
{
$this->strong = $strong;
$this->clientID = $clientID;
$this->clientName = $clientName;
$this->deviceName = $deviceName;
$this->clientVersion = $clientVersion;

8
src/Models/Operations/GetPlaylistContentsQueryParamType.php
View File

@@ -21,8 +21,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum GetPlaylistContentsQueryParamType: int
{
case One = 1;
case Two = 2;
case Three = 3;
case Four = 4;
case Movie = 1;
case Show = 2;
case Season = 3;
case Episode = 4;
}

16
src/Models/Operations/GetServerResourcesRequest.php
View File

@@ -11,18 +11,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
use LukeHagar\Plex_API\Utils\SpeakeasyMetadata;
class GetServerResourcesRequest
{
/**
* 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)
*
*
* @var ?string $clientID
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=X-Plex-Client-Identifier')]
public ?string $clientID = null;
/**
* Include Https entries in the results
*
@@ -51,14 +39,12 @@ class GetServerResourcesRequest
public ?IncludeIPv6 $includeIPv6 = null;
/**
* @param ?string $clientID
* @param ?IncludeHttps $includeHttps
* @param ?IncludeRelay $includeRelay
* @param ?IncludeIPv6 $includeIPv6
*/
public function __construct(?string $clientID = null, ?IncludeHttps $includeHttps = null, ?IncludeRelay $includeRelay = null, ?IncludeIPv6 $includeIPv6 = null)
public function __construct(?IncludeHttps $includeHttps = null, ?IncludeRelay $includeRelay = null, ?IncludeIPv6 $includeIPv6 = null)
{
$this->clientID = $clientID;
$this->includeHttps = $includeHttps;
$this->includeRelay = $includeRelay;
$this->includeIPv6 = $includeIPv6;

16
src/Models/Operations/GetTokenByPinIdRequest.php
View File

@@ -19,25 +19,11 @@ class GetTokenByPinIdRequest
#[SpeakeasyMetadata('pathParam:style=simple,explode=false,name=pinID')]
public int $pinID;
/**
* 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)
*
*
* @var ?string $clientID
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=X-Plex-Client-Identifier')]
public ?string $clientID = null;
/**
* @param int $pinID
* @param ?string $clientID
*/
public function __construct(int $pinID, ?string $clientID = null)
public function __construct(int $pinID)
{
$this->pinID = $pinID;
$this->clientID = $clientID;
}
}

4
src/Models/Operations/GetTokenDetailsUserPlexAccount.php
View File

@@ -166,7 +166,7 @@ class GetTokenDetailsUserPlexAccount
public int $id;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var int $joinedAt
*/
@@ -233,7 +233,7 @@ class GetTokenDetailsUserPlexAccount
public bool $protected;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var int $rememberExpiresAt
*/

8
src/Models/Operations/GetTopWatchedContentQueryParamType.php
View File

@@ -21,8 +21,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum GetTopWatchedContentQueryParamType: int
{
case One = 1;
case Two = 2;
case Three = 3;
case Four = 4;
case Movie = 1;
case Show = 2;
case Season = 3;
case Episode = 4;
}

4
src/Models/Operations/IncludeGuids.php
View File

@@ -16,6 +16,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum IncludeGuids: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

4
src/Models/Operations/IncludeHttps.php
View File

@@ -12,6 +12,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** Include Https entries in the results */
enum IncludeHttps: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

4
src/Models/Operations/IncludeIPv6.php
View File

@@ -12,6 +12,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** Include IPv6 entries in the results */
enum IncludeIPv6: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

4
src/Models/Operations/IncludeMeta.php
View File

@@ -16,6 +16,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum IncludeMeta: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

4
src/Models/Operations/IncludeRelay.php
View File

@@ -17,6 +17,6 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum IncludeRelay: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

16
src/Models/Operations/Location.php
View File

@@ -13,25 +13,23 @@ class Location
{
/**
*
* @var ?int $id
* @var int $id
*/
#[\JMS\Serializer\Annotation\SerializedName('id')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?int $id = null;
public int $id;
/**
*
* @var ?string $path
* @var string $path
*/
#[\JMS\Serializer\Annotation\SerializedName('path')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?string $path = null;
public string $path;
/**
* @param ?int $id
* @param ?string $path
* @param int $id
* @param string $path
*/
public function __construct(?int $id = null, ?string $path = null)
public function __construct(int $id, string $path)
{
$this->id = $id;
$this->path = $path;

32
src/Models/Operations/MediaGuid.php Normal file
View File

@@ -0,0 +1,32 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
class MediaGuid
{
/**
* Can be one of the following formats:
*
* imdb://tt13015952, tmdb://2434012, tvdb://7945991
*
*
* @var string $id
*/
#[\JMS\Serializer\Annotation\SerializedName('id')]
public string $id;
/**
* @param string $id
*/
public function __construct(string $id)
{
$this->id = $id;
}
}

5
src/Models/Operations/MediaReviewsVisibility.php
View File

@@ -9,8 +9,9 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** Whether or not the account has media reviews visibility enabled */
enum MediaReviewsVisibility: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

48
src/Models/Operations/Meta.php Normal file
View File

@@ -0,0 +1,48 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/**
* Meta - The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
*
*
*/
class Meta
{
/**
* $type
*
* @var ?array<GetLibraryItemsType> $type
*/
#[\JMS\Serializer\Annotation\SerializedName('Type')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsType>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $type = null;
/**
* $fieldType
*
* @var ?array<GetLibraryItemsFieldType> $fieldType
*/
#[\JMS\Serializer\Annotation\SerializedName('FieldType')]
#[\JMS\Serializer\Annotation\Type('array<\LukeHagar\Plex_API\Models\Operations\GetLibraryItemsFieldType>|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?array $fieldType = null;
/**
* @param ?array<GetLibraryItemsType> $type
* @param ?array<GetLibraryItemsFieldType> $fieldType
*/
public function __construct(?array $type = null, ?array $fieldType = null)
{
$this->type = $type;
$this->fieldType = $fieldType;
}
}

6
src/Models/Operations/PostUsersSignInDataAutoSelectSubtitle.php
View File

@@ -10,8 +10,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) */
enum PostUsersSignInDataAutoSelectSubtitle: string
enum PostUsersSignInDataAutoSelectSubtitle: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

8
src/Models/Operations/PostUsersSignInDataDefaultSubtitleAccessibility.php
View File

@@ -9,9 +9,9 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) */
enum PostUsersSignInDataDefaultSubtitleAccessibility: string
/** The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles) */
enum PostUsersSignInDataDefaultSubtitleAccessibility: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

6
src/Models/Operations/PostUsersSignInDataDefaultSubtitleForced.php
View File

@@ -10,8 +10,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
/** The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) */
enum PostUsersSignInDataDefaultSubtitleForced: string
enum PostUsersSignInDataDefaultSubtitleForced: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

5
src/Models/Operations/PostUsersSignInDataMediaReviewsVisibility.php
View File

@@ -9,8 +9,9 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** Whether or not the account has media reviews visibility enabled */
enum PostUsersSignInDataMediaReviewsVisibility: int
{
case Zero = 0;
case One = 1;
case Disable = 0;
case Enable = 1;
}

43
src/Models/Operations/PostUsersSignInDataRequest.php
View File

@@ -1,43 +0,0 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
use LukeHagar\Plex_API\Utils\SpeakeasyMetadata;
class PostUsersSignInDataRequest
{
/**
* 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)
*
*
* @var ?string $clientID
*/
#[SpeakeasyMetadata('queryParam:style=form,explode=true,name=X-Plex-Client-Identifier')]
public ?string $clientID = null;
/**
* Login credentials
*
* @var ?PostUsersSignInDataRequestBody $requestBody
*/
#[SpeakeasyMetadata('request:mediaType=application/x-www-form-urlencoded')]
public ?PostUsersSignInDataRequestBody $requestBody = null;
/**
* @param ?string $clientID
* @param ?PostUsersSignInDataRequestBody $requestBody
*/
public function __construct(?string $clientID = null, ?PostUsersSignInDataRequestBody $requestBody = null)
{
$this->clientID = $clientID;
$this->requestBody = $requestBody;
}
}

4
src/Models/Operations/PostUsersSignInDataUserPlexAccount.php
View File

@@ -166,7 +166,7 @@ class PostUsersSignInDataUserPlexAccount
public int $id;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var int $joinedAt
*/
@@ -233,7 +233,7 @@ class PostUsersSignInDataUserPlexAccount
public bool $protected;
/**
* Unix epoch datetime
* Unix epoch datetime in seconds
*
* @var int $rememberExpiresAt
*/

61
src/Models/Operations/PostUsersSignInDataUserProfile.php
View File

@@ -14,11 +14,10 @@ class PostUsersSignInDataUserProfile
/**
* If the account has automatically select audio and subtitle tracks enabled
*
* @var ?bool $autoSelectAudio
* @var bool $autoSelectAudio
*/
#[\JMS\Serializer\Annotation\SerializedName('autoSelectAudio')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?bool $autoSelectAudio = null;
public bool $autoSelectAudio;
/**
* The preferred audio language for the account
@@ -37,72 +36,64 @@ class PostUsersSignInDataUserProfile
public ?string $defaultSubtitleLanguage;
/**
* The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)
*
* @var ?PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle
* @var PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle
*/
#[\JMS\Serializer\Annotation\SerializedName('autoSelectSubtitle')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataAutoSelectSubtitle|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle = null;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataAutoSelectSubtitle')]
public PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle;
/**
* The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
*
* @var ?PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility
* @var PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility
*/
#[\JMS\Serializer\Annotation\SerializedName('defaultSubtitleAccessibility')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataDefaultSubtitleAccessibility|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility = null;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataDefaultSubtitleAccessibility')]
public PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility;
/**
* The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)
*
* @var ?PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced
* @var PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced
*/
#[\JMS\Serializer\Annotation\SerializedName('defaultSubtitleForced')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataDefaultSubtitleForced|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced = null;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataDefaultSubtitleForced')]
public PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced;
/**
*
* @var ?PostUsersSignInDataWatchedIndicator $watchedIndicator
* @var PostUsersSignInDataWatchedIndicator $watchedIndicator
*/
#[\JMS\Serializer\Annotation\SerializedName('watchedIndicator')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataWatchedIndicator|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?PostUsersSignInDataWatchedIndicator $watchedIndicator = null;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataWatchedIndicator')]
public PostUsersSignInDataWatchedIndicator $watchedIndicator;
/**
*
* @var ?PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility
* @var PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility
*/
#[\JMS\Serializer\Annotation\SerializedName('mediaReviewsVisibility')]
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataMediaReviewsVisibility|null')]
#[\JMS\Serializer\Annotation\SkipWhenNull]
public ?PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility = null;
#[\JMS\Serializer\Annotation\Type('\LukeHagar\Plex_API\Models\Operations\PostUsersSignInDataMediaReviewsVisibility')]
public PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility;
/**
* @param ?bool $autoSelectAudio
* @param bool $autoSelectAudio
* @param PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle
* @param PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility
* @param PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced
* @param PostUsersSignInDataWatchedIndicator $watchedIndicator
* @param PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility
* @param ?string $defaultAudioLanguage
* @param ?string $defaultSubtitleLanguage
* @param ?PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle
* @param ?PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility
* @param ?PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced
* @param ?PostUsersSignInDataWatchedIndicator $watchedIndicator
* @param ?PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility
*/
public function __construct(?bool $autoSelectAudio = null, ?string $defaultAudioLanguage = null, ?string $defaultSubtitleLanguage = null, ?PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle = null, ?PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility = null, ?PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced = null, ?PostUsersSignInDataWatchedIndicator $watchedIndicator = null, ?PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility = null)
public function __construct(bool $autoSelectAudio, PostUsersSignInDataAutoSelectSubtitle $autoSelectSubtitle, PostUsersSignInDataDefaultSubtitleAccessibility $defaultSubtitleAccessibility, PostUsersSignInDataDefaultSubtitleForced $defaultSubtitleForced, PostUsersSignInDataWatchedIndicator $watchedIndicator, PostUsersSignInDataMediaReviewsVisibility $mediaReviewsVisibility, ?string $defaultAudioLanguage = null, ?string $defaultSubtitleLanguage = null)
{
$this->autoSelectAudio = $autoSelectAudio;
$this->defaultAudioLanguage = $defaultAudioLanguage;
$this->defaultSubtitleLanguage = $defaultSubtitleLanguage;
$this->autoSelectSubtitle = $autoSelectSubtitle;
$this->defaultSubtitleAccessibility = $defaultSubtitleAccessibility;
$this->defaultSubtitleForced = $defaultSubtitleForced;
$this->watchedIndicator = $watchedIndicator;
$this->mediaReviewsVisibility = $mediaReviewsVisibility;
$this->defaultAudioLanguage = $defaultAudioLanguage;
$this->defaultSubtitleLanguage = $defaultSubtitleLanguage;
}
}

7
src/Models/Operations/PostUsersSignInDataWatchedIndicator.php
View File

@@ -9,8 +9,9 @@ declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
enum PostUsersSignInDataWatchedIndicator: string
/** Whether or not media watched indicators are enabled (little orange dot on media) */
enum PostUsersSignInDataWatchedIndicator: int
{
case Zero = '0';
case One = '1';
case Disable = 0;
case Enable = 1;
}

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

@@ -0,0 +1,17 @@
<?php
/**
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
declare(strict_types=1);
namespace LukeHagar\Plex_API\Models\Operations;
/** The protocol used for the connection (http, https, etc) */
enum Protocol: string
{
case Http = 'http';
case Https = 'https';
}

8
src/Models/Operations/QueryParamType.php
View File

@@ -21,8 +21,8 @@ namespace LukeHagar\Plex_API\Models\Operations;
*/
enum QueryParamType: int
{
case One = 1;
case Two = 2;
case Three = 3;
case Four = 4;
case Movie = 1;
case Show = 2;
case Season = 3;
case Episode = 4;
}

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