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.402.14

Browse Source
This commit is contained in:
speakeasybot
2024-09-26 00:10:42 +00:00
parent b6b61b6acb
commit ecc51bf153
206 changed files with 6848 additions and 968 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
.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.9.1
version: 0.10.0
clientServerStatusCodesAsErrors: true
flattenGlobalSecurity: true
imports:

12
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.401.2
speakeasyVersion: 1.402.14
sources:
my-source:
sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
tags:
- latest
- main
@@ -18,10 +18,10 @@ targets:
plexphp:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:fc6eebe661455e23b1aa352a91c14ef773fa72331330ec4caeddc2c460dc16bb
sourceBlobDigest: sha256:2e81e86c83d7f4e8842efca0d43a2db84a4932534c8439e3737e1f65c873f855
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
codeSamplesNamespace: code-samples-php-plexphp
codeSamplesRevisionDigest: sha256:2aef293ad566ab27122b647acfe022f3b6c648d564d9c05f6a8a7951841e4c8f
codeSamplesRevisionDigest: sha256:79772c55deda5b6a51423f1e52bde30280ceb6babc20a243a4905190cee8f142
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

3
README.md
View File

@@ -100,12 +100,13 @@ try {
### [Hubs](docs/sdks/hubs/README.md)
* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
* [getRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
### [Library](docs/sdks/library/README.md)
* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
* [getRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
* [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section

10
RELEASES.md
View File

@@ -623,3 +623,13 @@ Based on:
- [php v0.9.1] .
### Releases
- [Composer v0.9.1] https://packagist.org/packages/lukehagar/plex-api#v0.9.1 - .
## 2024-09-26 00:09:11
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.10.0] .
### Releases
- [Composer v0.10.0] https://packagist.org/packages/lukehagar/plex-api#v0.10.0 - .

89
codeSamples.yaml
View File

@@ -695,6 +695,49 @@ actions:
$response = $sdk->hubs->getGlobalHubs(1262.49, Operations\OnlyTransient::One);
if ($response->object !== null) {
// handle response
}
} catch (Throwable $e) {
// handle exception
}
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
update:
x-codeSamples:
- lang: php
label: added
source: |-
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();
try {
$request = new Operations\GetRecentlyAddedRequest(
contentDirectoryID: 470161,
sectionID: 2,
type: Operations\Type::TvShow,
includeMeta: Operations\IncludeMeta::Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
);
$response = $sdk->hubs->getRecentlyAdded($request);
if ($response->object !== null) {
// handle response
}
@@ -728,7 +771,7 @@ actions:
try {
$response = $sdk->search->performSearch('dylan', 5838.67, 5);
$response = $sdk->search->performSearch('dylan', 9372.69, 5);
if ($response->statusCode === 200) {
// handle response
@@ -1101,7 +1144,7 @@ actions:
update:
x-codeSamples:
- lang: php
label: getRecentlyAdded
label: library
source: |-
declare(strict_types=1);
@@ -1109,6 +1152,7 @@ actions:
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>",
@@ -1123,8 +1167,29 @@ actions:
->setSecurity($security)->build();
try {
$response = $sdk->library->getRecentlyAdded(0, 50);
$request = new Operations\GetRecentlyAddedLibraryRequest(
contentDirectoryID: 2,
pinnedContentDirectoryID: [
3,
5,
7,
13,
12,
1,
6,
14,
2,
10,
16,
17,
],
sectionID: 2,
type: Operations\QueryParamType::TvShow,
includeMeta: Operations\QueryParamIncludeMeta::Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
);
$response = $sdk->library->getRecentlyAddedLibrary($request);
if ($response->object !== null) {
// handle response
@@ -1342,7 +1407,7 @@ actions:
try {
$response = $sdk->library->getSearchLibrary(9518, Operations\QueryParamType::TvShow);
$response = $sdk->library->getSearchLibrary(9518, Operations\GetSearchLibraryQueryParamType::TvShow);
if ($response->object !== null) {
// handle response
@@ -1381,8 +1446,8 @@ actions:
sectionKey: 9518,
tag: Operations\Tag::Edition,
includeGuids: Operations\IncludeGuids::Enable,
includeMeta: Operations\IncludeMeta::Enable,
type: Operations\Type::TvShow,
type: Operations\GetLibraryItemsQueryParamType::TvShow,
includeMeta: Operations\GetLibraryItemsQueryParamIncludeMeta::Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
);
@@ -1601,9 +1666,9 @@ actions:
width: 110,
height: 165,
opacity: 643869,
blur: 4000,
blur: 0,
minSize: Operations\MinSize::One,
upscale: Operations\Upscale::Zero,
upscale: Operations\Upscale::One,
url: '/library/metadata/49564/thumb/1654258204',
);
$response = $sdk->server->getResizedPhoto($request);
@@ -2097,7 +2162,7 @@ actions:
try {
$response = $sdk->authentication->getSourceConnectionInformation('provider://provider-identifier');
$response = $sdk->authentication->getSourceConnectionInformation('server://client-identifier');
if ($response->statusCode === 200) {
// handle response
@@ -2581,10 +2646,12 @@ actions:
->build();
try {
$request = new Operations\PostUsersSignInDataRequestBody(
$request = new Operations\PostUsersSignInDataRequest(
requestBody: new Operations\PostUsersSignInDataRequestBody(
login: 'username@email.com',
password: 'password123',
verificationCode: '123456',
),
);
$response = $sdk->authentication->postUsersSignInData($request);

11
docs/Models/Errors/GetRecentlyAddedBadRequest.md
View File

@@ -1,11 +0,0 @@
# GetRecentlyAddedBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `errors` | array<[Errors\GetRecentlyAddedErrors](../../Models/Errors/GetRecentlyAddedErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/Models/Errors/GetRecentlyAddedErrors.md
View File

@@ -1,10 +0,0 @@
# GetRecentlyAddedErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |

4
docs/Models/Errors/GetRecentlyAddedUnauthorized.md → docs/Models/Errors/GetRecentlyAddedLibraryBadRequest.md
View File

@@ -1,6 +1,6 @@
# GetRecentlyAddedUnauthorized
# GetRecentlyAddedLibraryBadRequest
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields

8
docs/Models/Errors/GetRecentlyAddedLibraryErrors.md
View File

@@ -4,7 +4,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *?string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *?int* | :heavy_minus_sign: | N/A | 400 |

10
docs/Models/Errors/GetRecentlyAddedLibraryLibraryErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetRecentlyAddedLibraryLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *?int* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *?string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *?int* | :heavy_minus_sign: | N/A | 401 |

11
docs/Models/Errors/GetRecentlyAddedLibraryUnauthorized.md Normal file
View File

@@ -0,0 +1,11 @@
# GetRecentlyAddedLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `errors` | array<[Errors\GetRecentlyAddedLibraryLibraryErrors](../../Models/Errors/GetRecentlyAddedLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Peyton Reed |
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |

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

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *?string* | :heavy_minus_sign: | N/A | label |
| `title` | *?string* | :heavy_minus_sign: | N/A | Label |
| `type` | *?string* | :heavy_minus_sign: | N/A | tag |
| `subType` | *?string* | :heavy_minus_sign: | N/A | bitrate |
| `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 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `type` | *?string* | :heavy_minus_sign: | N/A | resolution |
| `operator` | array<[Operations\Operator](../../Models/Operations/Operator.md)> | :heavy_minus_sign: | N/A | |
| `type` | *string* | :heavy_check_mark: | N/A | tag |
| `operator` | array<[Operations\Operator](../../Models/Operations/Operator.md)> | :heavy_check_mark: | N/A | |

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

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Comedy |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Adventure |

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

@@ -23,6 +23,6 @@
| `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 |
| `contentChangedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
| `location` | array<[Operations\Location](../../Models/Operations/Location.md)> | :heavy_check_mark: | N/A | |

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

@@ -0,0 +1,11 @@
# GetLibraryDetailsField
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *?string* | :heavy_minus_sign: | N/A | label |
| `title` | *?string* | :heavy_minus_sign: | N/A | Label |
| `type` | *?string* | :heavy_minus_sign: | N/A | tag |
| `subType` | *?string* | :heavy_minus_sign: | N/A | bitrate |

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

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

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

@@ -19,4 +19,4 @@
| `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 |
| `directory` | array<[Operations\GetLibraryDetailsDirectory](../../Models/Operations/GetLibraryDetailsDirectory.md)> | :heavy_minus_sign: | N/A | |
| `type` | array<[Operations\GetLibraryDetailsType](../../Models/Operations/GetLibraryDetailsType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\FieldType](../../Models/Operations/FieldType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\GetLibraryDetailsFieldType](../../Models/Operations/GetLibraryDetailsFieldType.md)> | :heavy_minus_sign: | N/A | |

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

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

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

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

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

@@ -10,5 +10,5 @@
| `title` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `filter` | array<[Operations\GetLibraryDetailsFilter](../../Models/Operations/GetLibraryDetailsFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\Sort](../../Models/Operations/Sort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\Field](../../Models/Operations/Field.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetLibraryDetailsSort](../../Models/Operations/GetLibraryDetailsSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetLibraryDetailsField](../../Models/Operations/GetLibraryDetailsField.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,8 @@
# GetLibraryItemsCollection
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Working NL Subs |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsFlattenSeasons
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsHasThumbnail
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

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

@@ -4,7 +4,7 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [Operations\GetLibraryItemsLibraryResponseType](../../Models/Operations/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
| `type` | [Operations\GetLibraryItemsLibraryResponse200Type](../../Models/Operations/GetLibraryItemsLibraryResponse200Type.md) | :heavy_check_mark: | N/A | background |
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,11 @@
# GetLibraryItemsLibraryField
## 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/GetLibraryItemsLibraryFieldType.md Normal file
View File

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

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

@@ -0,0 +1,12 @@
# GetLibraryItemsLibraryFilter
## 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 |

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

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

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

@@ -0,0 +1,11 @@
# GetLibraryItemsLibraryResponse200Type
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |

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

@@ -1,11 +1,14 @@
# GetLibraryItemsLibraryResponseType
## Values
## Fields
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| 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\GetLibraryItemsLibraryFilter](../../Models/Operations/GetLibraryItemsLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetLibraryItemsLibrarySort](../../Models/Operations/GetLibraryItemsLibrarySort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetLibraryItemsLibraryField](../../Models/Operations/GetLibraryItemsLibraryField.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,15 @@
# GetLibraryItemsLibrarySort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `defaultDirection` | [Operations\GetLibraryItemsLibraryDefaultDirection](../../Models/Operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | 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 |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetLibraryItemsLibraryActiveDirection](../../Models/Operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |

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

@@ -1,14 +1,14 @@
# GetLibraryItemsLibraryType
The type of media content
## 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 | |
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |

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

@@ -4,7 +4,7 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
@@ -21,3 +21,5 @@
| `part` | array<[Operations\GetLibraryItemsPart](../../Models/Operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [?Operations\GetLibraryItemsOptimizedForStreaming](../../Models/Operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |

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

@@ -1,10 +1,13 @@
# GetLibraryItemsMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
@@ -12,7 +15,7 @@
| `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 | |
| `librarySectionID` | *int* | :heavy_check_mark: | N/A | 1 |
| `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/ |
@@ -22,7 +25,9 @@
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | N/A | |
| `type` | array<[Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
| `nocache` | *?bool* | :heavy_minus_sign: | N/A | true |
| `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | true |
| `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/> | |
| `meta` | [?Operations\GetLibraryItemsMeta](../../Models/Operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |

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

@@ -0,0 +1,8 @@
# GetLibraryItemsMediaGuid
## 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 |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsMeta
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\GetLibraryItemsLibraryResponseType](../../Models/Operations/GetLibraryItemsLibraryResponseType.md)> | :heavy_minus_sign: | N/A |
| `fieldType` | array<[Operations\GetLibraryItemsLibraryFieldType](../../Models/Operations/GetLibraryItemsLibraryFieldType.md)> | :heavy_minus_sign: | N/A |

10
docs/Models/Operations/GetLibraryItemsMetaDataRating.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryItemsMetaDataRating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

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

@@ -8,12 +8,15 @@
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `type` | [Operations\GetLibraryItemsLibraryType](../../Models/Operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
@@ -21,8 +24,8 @@
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
| `seasonCount` | *?int* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [?Operations\FlattenSeasons](../../Models/Operations/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [?Operations\ShowOrdering](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `flattenSeasons` | [?Operations\GetLibraryItemsFlattenSeasons](../../Models/Operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [?Operations\GetLibraryItemsShowOrdering](../../Models/Operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
@@ -38,6 +41,7 @@
| `grandparentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparentArt` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
| `grandparentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
@@ -46,10 +50,11 @@
| `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 | |
| `collection` | array<[Operations\Collection](../../Models/Operations/Collection.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\GetLibraryItemsCollection](../../Models/Operations/GetLibraryItemsCollection.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/> | |
| `ultraBlurColors` | [?Operations\UltraBlurColors](../../Models/Operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `mediaGuid` | array<[Operations\GetLibraryItemsMediaGuid](../../Models/Operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultraBlurColors` | [?Operations\GetLibraryItemsUltraBlurColors](../../Models/Operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | array<[Operations\GetLibraryItemsMetaDataRating](../../Models/Operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
| `image` | array<[Operations\GetLibraryItemsImage](../../Models/Operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |

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

@@ -0,0 +1,9 @@
# GetLibraryItemsOptimizedForStreaming
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -13,5 +13,8 @@
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `hasThumbnail` | [?Operations\HasThumbnail](../../Models/Operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `hasThumbnail` | [?Operations\GetLibraryItemsHasThumbnail](../../Models/Operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\GetLibraryItemsStream](../../Models/Operations/GetLibraryItemsStream.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,12 @@
# GetLibraryItemsQueryParamIncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

19
docs/Models/Operations/GetLibraryItemsQueryParamType.md Normal file
View File

@@ -0,0 +1,19 @@
# GetLibraryItemsQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

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

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

@@ -4,5 +4,10 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Sigourney Weaver |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
| `filter` | *?string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
| `thumb` | *?string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
| `tag` | *?string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
| `tagKey` | *?string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
| `role` | *?string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |

20
docs/Models/Operations/GetLibraryItemsShowOrdering.md Normal file
View File

@@ -0,0 +1,20 @@
# GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
## Values
| Name | Value |
| ------------ | ------------ |
| `None` | None |
| `TmdbAiring` | tmdbAiring |
| `Aired` | aired |
| `Dvd` | dvd |
| `Absolute` | absolute |

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

@@ -4,12 +4,12 @@
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `defaultDirection` | [Operations\DefaultDirection](../../Models/Operations/DefaultDirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `defaultDirection` | [Operations\GetLibraryItemsDefaultDirection](../../Models/Operations/GetLibraryItemsDefaultDirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | 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 |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\ActiveDirection](../../Models/Operations/ActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `activeDirection` | [?Operations\GetLibraryItemsActiveDirection](../../Models/Operations/GetLibraryItemsActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |

45
docs/Models/Operations/GetLibraryItemsStream.md Normal file
View File

@@ -0,0 +1,45 @@
# GetLibraryItemsStream
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
| `colorTrc` | *?string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
| `bitDepth` | *?int* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | The chroma location of the video stream | left |
| `streamIdentifier` | *?string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
| `codedHeight` | *?int* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
| `codedWidth` | *?int* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
| `frameRate` | *?float* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | N/A | false |
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | false |
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `height` | *?int* | :heavy_minus_sign: | The height of the video stream | 1080 |
| `level` | *?int* | :heavy_minus_sign: | The level of the video codec | 40 |
| `profile` | *?string* | :heavy_minus_sign: | The profile of the video codec | main |
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames | 4 |
| `scanType` | *?string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
| `width` | *?int* | :heavy_minus_sign: | The width of the video stream | 1920 |
| `displayTitle` | *?string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
| `language` | *?string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag of the stream | en |
| `languageCode` | *?string* | :heavy_minus_sign: | Language code of the stream | eng |
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | The audio channel layout | stereo |
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
| `title` | *?string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |

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

@@ -1,14 +1,14 @@
# GetLibraryItemsType
The type of media content
## Fields
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| 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 | |

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

@@ -0,0 +1,11 @@
# GetLibraryItemsUltraBlurColors
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `topLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
| `topRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
| `bottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
| `bottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |

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

@@ -4,7 +4,7 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 15 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
| `duration` | *?int* | :heavy_minus_sign: | N/A | 141417 |
@@ -15,4 +15,4 @@
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |
| `stream` | array<[Operations\Stream](../../Models/Operations/Stream.md)> | :heavy_minus_sign: | N/A | |
| `stream` | array<[Operations\GetMetaDataByRatingKeyStream](../../Models/Operations/GetMetaDataByRatingKeyStream.md)> | :heavy_minus_sign: | N/A | |

39
docs/Models/Operations/GetMetaDataByRatingKeyStream.md Normal file
View File

@@ -0,0 +1,39 @@
# GetMetaDataByRatingKeyStream
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *?int* | :heavy_minus_sign: | N/A | 29 |
| `streamType` | *?int* | :heavy_minus_sign: | N/A | 2 |
| `default` | *?bool* | :heavy_minus_sign: | N/A | true |
| `codec` | *?string* | :heavy_minus_sign: | N/A | aac |
| `index` | *?int* | :heavy_minus_sign: | N/A | 0 |
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 128 |
| `bitDepth` | *?int* | :heavy_minus_sign: | N/A | 8 |
| `chromaLocation` | *?string* | :heavy_minus_sign: | N/A | left |
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | N/A | 14520 |
| `codedHeight` | *?int* | :heavy_minus_sign: | N/A | 816 |
| `codedWidth` | *?int* | :heavy_minus_sign: | N/A | 1920 |
| `colorPrimaries` | *?string* | :heavy_minus_sign: | N/A | bt709 |
| `colorRange` | *?string* | :heavy_minus_sign: | N/A | tv |
| `colorSpace` | *?string* | :heavy_minus_sign: | N/A | bt709 |
| `colorTrc` | *?string* | :heavy_minus_sign: | N/A | bt709 |
| `frameRate` | *?int* | :heavy_minus_sign: | N/A | 24 |
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
| `height` | *?int* | :heavy_minus_sign: | N/A | 814 |
| `level` | *?int* | :heavy_minus_sign: | N/A | 40 |
| `profile` | *?string* | :heavy_minus_sign: | N/A | lc |
| `refFrames` | *?int* | :heavy_minus_sign: | N/A | 4 |
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
| `streamIdentifier` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `width` | *?int* | :heavy_minus_sign: | N/A | 1920 |
| `displayTitle` | *?string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
| `selected` | *?bool* | :heavy_minus_sign: | N/A | true |
| `channels` | *?int* | :heavy_minus_sign: | N/A | 2 |
| `language` | *?string* | :heavy_minus_sign: | N/A | English |
| `languageTag` | *?string* | :heavy_minus_sign: | N/A | en |
| `languageCode` | *?string* | :heavy_minus_sign: | N/A | eng |
| `samplingRate` | *?int* | :heavy_minus_sign: | N/A | 44100 |

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

@@ -4,8 +4,9 @@
## 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 |

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

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

@@ -0,0 +1,11 @@
# GetRecentlyAddedField
## 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/GetRecentlyAddedFieldType.md Normal file
View File

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

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedFilter
## 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 |

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

@@ -0,0 +1,11 @@
# GetRecentlyAddedHubsResponseType
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedHubsType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |

10
docs/Models/Operations/GetRecentlyAddedImage.md Normal file
View File

@@ -0,0 +1,10 @@
# GetRecentlyAddedImage
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `type` | [Operations\GetRecentlyAddedHubsResponseType](../../Models/Operations/GetRecentlyAddedHubsResponseType.md) | :heavy_check_mark: | N/A | background |
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

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

@@ -0,0 +1,8 @@
# GetRecentlyAddedLibraryCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | United States of America |

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

@@ -0,0 +1,8 @@
# GetRecentlyAddedLibraryDirector
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Peyton Reed |

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

@@ -0,0 +1,12 @@
# GetRecentlyAddedLibraryFilter
## 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 |

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

@@ -0,0 +1,8 @@
# GetRecentlyAddedLibraryGenre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Comedy |

23
docs/Models/Operations/GetRecentlyAddedLibraryMedia.md Normal file
View File

@@ -0,0 +1,23 @@
# GetRecentlyAddedLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 120345 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `bitrate` | *?float* | :heavy_minus_sign: | N/A | 3623 |
| `width` | *?float* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *?float* | :heavy_minus_sign: | N/A | 804 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *?float* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | ac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *?float* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *?float* | :heavy_minus_sign: | N/A | 0 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |
| `part` | array<[Operations\GetRecentlyAddedLibraryPart](../../Models/Operations/GetRecentlyAddedLibraryPart.md)> | :heavy_minus_sign: | N/A | |

19
docs/Models/Operations/GetRecentlyAddedLibraryMediaContainer.md Normal file
View File

@@ -0,0 +1,19 @@
# GetRecentlyAddedLibraryMediaContainer
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `type` | array<[Operations\GetRecentlyAddedLibraryType](../../Models/Operations/GetRecentlyAddedLibraryType.md)> | :heavy_minus_sign: | N/A | |
| `fieldType` | array<[Operations\FieldType](../../Models/Operations/FieldType.md)> | :heavy_minus_sign: | N/A | |
| `size` | *?float* | :heavy_minus_sign: | N/A | 50 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?float* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | |
| `metadata` | array<[Operations\GetRecentlyAddedLibraryMetadata](../../Models/Operations/GetRecentlyAddedLibraryMetadata.md)> | :heavy_minus_sign: | N/A | |

39
docs/Models/Operations/GetRecentlyAddedLibraryMetadata.md Normal file
View File

@@ -0,0 +1,39 @@
# GetRecentlyAddedLibraryMetadata
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `librarySectionID` | *?float* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `ratingKey` | *?float* | :heavy_minus_sign: | N/A | 59398 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | Marvel Studios |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 4.7 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 8.3 |
| `year` | *?float* | :heavy_minus_sign: | N/A | 2023 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
| `addedAt` | *?float* | :heavy_minus_sign: | N/A | 1681803215 |
| `updatedAt` | *?float* | :heavy_minus_sign: | N/A | 1681888010 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
| `media` | array<[Operations\GetRecentlyAddedLibraryMedia](../../Models/Operations/GetRecentlyAddedLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
| `genre` | array<[Operations\GetRecentlyAddedLibraryGenre](../../Models/Operations/GetRecentlyAddedLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\GetRecentlyAddedLibraryDirector](../../Models/Operations/GetRecentlyAddedLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\GetRecentlyAddedLibraryWriter](../../Models/Operations/GetRecentlyAddedLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\GetRecentlyAddedLibraryCountry](../../Models/Operations/GetRecentlyAddedLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\GetRecentlyAddedLibraryRole](../../Models/Operations/GetRecentlyAddedLibraryRole.md)> | :heavy_minus_sign: | N/A | |

17
docs/Models/Operations/GetRecentlyAddedLibraryPart.md Normal file
View File

@@ -0,0 +1,17 @@
# GetRecentlyAddedLibraryPart
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 120353 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `file` | *?string* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
| `size` | *?float* | :heavy_minus_sign: | N/A | 3395307162 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | |
| `hasThumbnail` | *?float* | :heavy_minus_sign: | N/A | 1 |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |

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

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

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

@@ -0,0 +1,11 @@
# GetRecentlyAddedLibraryResponse
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [?Operations\GetRecentlyAddedLibraryResponseBody](../../Models/Operations/GetRecentlyAddedLibraryResponseBody.md) | :heavy_minus_sign: | The recently added content |

10
docs/Models/Operations/GetRecentlyAddedLibraryResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetRecentlyAddedLibraryResponseBody
The recently added content
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [?Operations\GetRecentlyAddedLibraryMediaContainer](../../Models/Operations/GetRecentlyAddedLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

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

@@ -0,0 +1,8 @@
# GetRecentlyAddedLibraryRole
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Paul Rudd |

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedLibraryType
## 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\GetRecentlyAddedLibraryFilter](../../Models/Operations/GetRecentlyAddedLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\Sort](../../Models/Operations/Sort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\Field](../../Models/Operations/Field.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,8 @@
# GetRecentlyAddedLibraryWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *?string* | :heavy_minus_sign: | N/A | Jeff Loveness |

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

@@ -5,10 +5,10 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `size` | *?float* | :heavy_minus_sign: | N/A | 50 |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `size` | *float* | :heavy_check_mark: | N/A | 50 |
| `offset` | *?int* | :heavy_minus_sign: | N/A | |
| `totalSize` | *?int* | :heavy_minus_sign: | N/A | |
| `identifier` | *?string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `mediaTagPrefix` | *?string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *?float* | :heavy_minus_sign: | N/A | 1680021154 |
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | |
| `allowSync` | *?bool* | :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/> | |
| `metadata` | array<[Operations\GetRecentlyAddedMetadata](../../Models/Operations/GetRecentlyAddedMetadata.md)> | :heavy_minus_sign: | N/A | |

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

@@ -4,36 +4,77 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *?bool* | :heavy_minus_sign: | N/A | |
| `librarySectionID` | *?float* | :heavy_minus_sign: | N/A | 1 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `type` | [Operations\GetRecentlyAddedHubsType](../../Models/Operations/GetRecentlyAddedHubsType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `ratingKey` | *?float* | :heavy_minus_sign: | N/A | 59398 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
| `guid` | *?string* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
| `studio` | *?string* | :heavy_minus_sign: | N/A | Marvel Studios |
| `type` | *?string* | :heavy_minus_sign: | N/A | movie |
| `title` | *?string* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *?string* | :heavy_minus_sign: | N/A | Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible. |
| `rating` | *?float* | :heavy_minus_sign: | N/A | 4.7 |
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 8.3 |
| `year` | *?float* | :heavy_minus_sign: | N/A | 2023 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
| `addedAt` | *?float* | :heavy_minus_sign: | N/A | 1681803215 |
| `updatedAt` | *?float* | :heavy_minus_sign: | N/A | 1681888010 |
| `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 |
| `seasonCount` | *?int* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [?Operations\FlattenSeasons](../../Models/Operations/FlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
| `showOrdering` | [?Operations\ShowOrdering](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/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 |
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
| `media` | array<[Operations\Media](../../Models/Operations/Media.md)> | :heavy_minus_sign: | N/A | |
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | N/A | 66 |
| `grandparentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `grandparentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `grandparentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
| `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\Media](../../Models/Operations/Media.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `genre` | array<[Operations\Genre](../../Models/Operations/Genre.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\Country](../../Models/Operations/Country.md)> | :heavy_minus_sign: | N/A | |
| `director` | array<[Operations\Director](../../Models/Operations/Director.md)> | :heavy_minus_sign: | N/A | |
| `writer` | array<[Operations\Writer](../../Models/Operations/Writer.md)> | :heavy_minus_sign: | N/A | |
| `country` | array<[Operations\Country](../../Models/Operations/Country.md)> | :heavy_minus_sign: | N/A | |
| `collection` | array<[Operations\Collection](../../Models/Operations/Collection.md)> | :heavy_minus_sign: | N/A | |
| `role` | array<[Operations\Role](../../Models/Operations/Role.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/> | |
| `ultraBlurColors` | [?Operations\UltraBlurColors](../../Models/Operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | array<[Operations\MetaDataRating](../../Models/Operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
| `image` | array<[Operations\GetRecentlyAddedImage](../../Models/Operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *?int* | :heavy_minus_sign: | N/A | 1682752242 |
| `originalTitle` | *?string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `viewOffset` | *?int* | :heavy_minus_sign: | N/A | 5222500 |
| `skipCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `index` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `theme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `leafCount` | *?int* | :heavy_minus_sign: | N/A | 14 |
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | N/A | 0 |
| `childCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `hasPremiumExtras` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `hasPremiumPrimaryExtra` | *?string* | :heavy_minus_sign: | N/A | 1 |
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
| `parentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `parentStudio` | *?string* | :heavy_minus_sign: | N/A | UCP |
| `parentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
| `parentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
| `parentIndex` | *?int* | :heavy_minus_sign: | N/A | 1 |
| `parentYear` | *?int* | :heavy_minus_sign: | N/A | 2010 |
| `parentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `parentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

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

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

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

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

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

@@ -8,4 +8,4 @@
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [?Operations\GetRecentlyAddedResponseBody](../../Models/Operations/GetRecentlyAddedResponseBody.md) | :heavy_minus_sign: | The recently added content |
| `object` | [?Operations\GetRecentlyAddedResponseBody](../../Models/Operations/GetRecentlyAddedResponseBody.md) | :heavy_minus_sign: | A successful response with recently added content. |

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

@@ -1,6 +1,6 @@
# GetRecentlyAddedResponseBody
The recently added content
A successful response with recently added content.
## Fields

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

@@ -0,0 +1,15 @@
# GetRecentlyAddedSort
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `defaultDirection` | [Operations\GetRecentlyAddedDefaultDirection](../../Models/Operations/GetRecentlyAddedDefaultDirection.md) | :heavy_check_mark: | The direction of the sort. Can be either `asc` or `desc`.<br/> | 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 |
| `active` | *?bool* | :heavy_minus_sign: | N/A | false |
| `activeDirection` | [?Operations\GetRecentlyAddedActiveDirection](../../Models/Operations/GetRecentlyAddedActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |

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

@@ -0,0 +1,14 @@
# GetRecentlyAddedType
## 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\GetRecentlyAddedFilter](../../Models/Operations/GetRecentlyAddedFilter.md)> | :heavy_minus_sign: | N/A | |
| `sort` | array<[Operations\GetRecentlyAddedSort](../../Models/Operations/GetRecentlyAddedSort.md)> | :heavy_minus_sign: | N/A | |
| `field` | array<[Operations\GetRecentlyAddedField](../../Models/Operations/GetRecentlyAddedField.md)> | :heavy_minus_sign: | N/A | |

19
docs/Models/Operations/GetSearchLibraryQueryParamType.md Normal file
View File

@@ -0,0 +1,19 @@
# GetSearchLibraryQueryParamType
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |

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

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [Operations\QueryParamType](../../Models/Operations/QueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `type` | [Operations\GetSearchLibraryQueryParamType](../../Models/Operations/GetSearchLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

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

@@ -1,17 +0,0 @@
# LibrarySectionID
## Supported Types
### `int`
```php
int $value = /* values here */
```
### `string`
```php
string $value = /* values here */
```

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

@@ -4,20 +4,22 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 120345 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `bitrate` | *?float* | :heavy_minus_sign: | N/A | 3623 |
| `width` | *?float* | :heavy_minus_sign: | N/A | 1920 |
| `height` | *?float* | :heavy_minus_sign: | N/A | 804 |
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 2.35 |
| `audioChannels` | *?float* | :heavy_minus_sign: | N/A | 6 |
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | ac3 |
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | h264 |
| `videoResolution` | *?float* | :heavy_minus_sign: | N/A | 1080 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
| `optimizedForStreaming` | *?float* | :heavy_minus_sign: | N/A | 0 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |
| `part` | array<[Operations\Part](../../Models/Operations/Part.md)> | :heavy_minus_sign: | N/A | |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
| `width` | *int* | :heavy_check_mark: | N/A | 3840 |
| `height` | *int* | :heavy_check_mark: | N/A | 2072 |
| `aspectRatio` | *float* | :heavy_check_mark: | N/A | 1.85 |
| `audioChannels` | *int* | :heavy_check_mark: | N/A | 6 |
| `audioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
| `videoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
| `videoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
| `videoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
| `part` | array<[Operations\Part](../../Models/Operations/Part.md)> | :heavy_check_mark: | N/A | |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | [?Operations\OptimizedForStreaming](../../Models/Operations/OptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |

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

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

10
docs/Models/Operations/MetaDataRating.md Normal file
View File

@@ -0,0 +1,10 @@
# MetaDataRating
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *?string* | :heavy_minus_sign: | N/A | = |
| `title` | *?string* | :heavy_minus_sign: | N/A | is |
| `key` | *string* | :heavy_check_mark: | N/A | = |
| `title` | *string* | :heavy_check_mark: | N/A | is |

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

@@ -0,0 +1,9 @@
# OptimizedForStreaming
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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

@@ -4,14 +4,17 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id` | *?float* | :heavy_minus_sign: | N/A | 120353 |
| `key` | *?string* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
| `duration` | *?float* | :heavy_minus_sign: | N/A | 7474422 |
| `file` | *?string* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
| `size` | *?float* | :heavy_minus_sign: | N/A | 3395307162 |
| `container` | *?string* | :heavy_minus_sign: | N/A | mp4 |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | |
| `hasThumbnail` | *?float* | :heavy_minus_sign: | N/A | 1 |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | |
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | high |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
| `videoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
| `hasThumbnail` | [?Operations\HasThumbnail](../../Models/Operations/HasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `stream` | array<[Operations\Stream](../../Models/Operations/Stream.md)> | :heavy_minus_sign: | N/A | |

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

@@ -0,0 +1,13 @@
# 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 |
| `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 |
| `requestBody` | [?Operations\PostUsersSignInDataRequestBody](../../Models/Operations/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -0,0 +1,12 @@
# QueryParamIncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

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